On Thu, Feb 10, 2011 at 2:11 PM, Gordon Sim <[email protected]> wrote:

> On 02/10/2011 02:54 PM, Rajith Attapattu wrote:
>
>> The above is not a formal authoritative document that describes what our
>> Common API is.
>>
>
> If by authoritative you mean '100% accurate and complete' then I accept it
> is not there yet.
>

Actually by authoritative I didn't really mean accuracy and completeness,
rather I was expecting a document in a different form.
Perhaps something similar to the JMS spec. I believe you and I have a
different vision about how this document should look like.
Perhaps that is where the disconnect is. As time permits I will try to work
out a document and post it to provide a more complete picture of what I was
envisaging.


>  The one I am looking for should describe,
>> - The interfaces and their respective methods.
>> - The intended behaviour of these methods.
>>
>
> We do describe the key methods and aspects of their behaviour. I agree a
> more complete listing of methods and their function would be a useful
> addition.


No disagreements there. I am the first to acknowledge that the current docs
are a massive improvement over what we had.
I am also a little unsure if the programming guide is the best place to add
a complete listing of methods and their functions.



>
>
>  - The common message formats we support and how they behave.
>>
>
> We describe map messages in section 2.11. We should add list messages in
> as well.
>
> In addition to these points we have quite a bit on addressing (which forms
> a central part of the API) and its mapping to AMQP 0-10 (though that needs
> to be spelled out in even more detail). We are still missing information on
> exceptions and error conditions.
>
> Yes the addressing has substantial information, and perhaps a tad more than
necessary in certain instances.
I believe the current programming guide has quite a bit of information, but
IMO not necessarily in the best format.
Also I believe some sections have more info than needed and that confuses
the users.

I think it's a matter of presenting what we've got in a more suitable way.
I need to think about this a bit more and will at some point try to provide
an alternative approach to get some feedback.


>  I am looking for a document that describes our
>> Common API in a single document and it is not there.
>>
>
> I believe it is there, but it is incomplete.



>
>
> ---------------------------------------------------------------------
> 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