On Thu, Feb 10, 2011 at 4:52 AM, Gordon Sim <[email protected]> wrote:

> On 02/10/2011 03:26 AM, Rajith Attapattu wrote:
>
>> We do proclaim that we have a common Messaging API for all our non JMS
>> clients (Ex. Python, C++, Perl ..etc)
>> But no where in our website (or for that matter in our documentation) we
>> specify what this common API is.
>>
>
> c++: http://qpid.apache.org/apis/0.8/cpp/html/modules.html
> python: http://qpid.apache.org/apis/0.8/python/html/index.html
>
> Both linked from the main documentation page under the section on 'API
> Reference Documentation'.
>
>
Gordon, I was aware of the individual API docs for both python and C++, but
thats not what I was referring to.
One should not have to read all the individual API docs in order to figure
out what is common and what is not !
As it is there are subtle variations between these API's in terms of methods
as well as behaviour.
Majority doesn't seems to know which one is the intended one which one is
not.

What I was specifically looking for is what exactly do we advertise as the
"Common API" - what exactly does it look like ?
What are the common Interfaces one can expect to see in all the language
clients
What is the behaviour one can expect to see in each of those methods

We need to provide that information to our users along with a guarantee that
the said interfaces are going to be stable going forward.

I do understand that in addition to the common API methods, each language
implementation may have language specific idioms.
Also some of the common methods may need to be tweaked in order to
workaround certain issues and or to overcome the impedance mismatch btw the
said language and the base client.
Ex. The PHP client issues described by Paul Colby.

If we want to document those things, we need to first have a document that
describes the "Common API".
Then we can explain the language specific additions and workarounds which
will give a user a better understanding of the client they are using.

Regards,

Rajith.


> ---------------------------------------------------------------------
> Apache Qpid - AMQP Messaging Implementation
> Project:      http://qpid.apache.org
> Use/Interact: mailto:[email protected]
>
>


-- 
Regards,

Rajith Attapattu
Red Hat
http://rajith.2rlabs.com/

Reply via email to