[QPID-7064] Document Asynchronous Error Notification API on Connection, Session, Receiver, and Sender objects

• Type: Bug
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 0.32
• Fix Version/s: qpid-python-1.35.0
• Component/s: Python Client
• Labels: documentation
• Assignee: Ken Giusti
• Reporter: Brian Bouterse
• Created: 12/Feb/16 20:54
• Updated: 06/Sep/16 20:43
• Resolved: 16/Feb/16 20:10

Description

With the fixing of QPID-7053 an asynchronous exception notification callback is added to the Connection, Session, Receiver, and Sender objects in qpid.messaging. The purpose and usage of this is not immediately obvious and would benefit from documentation being added. It also needs to explain that it is forbidden to call back in qpid.messaging from within the callback handler. Also it needs to identify the required function signature that the developer must adhere to to create a usable callback and then how to register it.

I propose this documentation be added at the object level so it appears in the main-page of each object type and not at the function level.

Issue Links

• is part of: QPID-7053 Exception Notifier Callback