Qpid
  1. Qpid
  2. QPID-3145

messaging::Message API needs to be documented, little to no Doxygen comments

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 0.8
    • Fix Version/s: 0.11
    • Component/s: C++ Client
    • Labels:
    • Environment:

      C++ API

      Description

      The documentation of everything in this class is represented by about 100 words, mostly representing the obvious that can be inferred by the method name.

      Questions:
      1. Can you tell by calling getContentType whether to call getContent or getContentPtr or getProperties, or does that
      require the sender to set the content?
      2. If using the xml mentioned in the AMQP Messaging (Part 2), does Variant.getString() return that xml?
      3. By setting TTL, Durable, Redelivered, what behavior does the system exhibit?
      4. Does the broker modify any of the settings or are they only for use by the broker? MessageId?
      5. Are there any conventions that should be followed for string data in this class that are used in other AMQP systems or language versions of Apid?
      6. On getting the char* to the data on getContentPtr, what is the life of that data, are you expected to copy it or are you passed ownership responsibility?

        Activity

        Hide
        Gordon Sim added a comment -

        Marking this fixed for now, can raise new more specific improvement requests as needed.

        Show
        Gordon Sim added a comment - Marking this fixed for now, can raise new more specific improvement requests as needed.
        Hide
        Gordon Sim added a comment -
        Show
        Gordon Sim added a comment - Additional comments added in http://svn.apache.org/viewvc?rev=1135614&view=rev

          People

          • Assignee:
            Gordon Sim
            Reporter:
            David Hickerson
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Time Tracking

              Estimated:
              Original Estimate - 2h
              2h
              Remaining:
              Remaining Estimate - 2h
              2h
              Logged:
              Time Spent - Not Specified
              Not Specified

                Development