bmqa.txt

@PURPOSE: Provide applications public API for the BlazingMQ SDK.

@MNEMONIC: BlazingMQ API (bmqa)

@DESCRIPTION: The 'bmqa' package provides the public API of the BlazingMQ SDK
 for applications to use.

/Hierarchical Synopsis
/---------------------
The 'bmqa' package currently has 8 components having 6 levels of physical
dependency.  The list below shows the hierarchical ordering of the components.
..
  6. bmqa_session

  5. bmqa_event
     bmqa_messageeventbuilder

  4. bmqa_messageevent

  3. bmqa_messageiterator

  2. bmqa_message
     bmqa_openqueuestatus
     bmqa_closequeuestatus
     bmqa_configurequeuestatus
     bmqa_sessionevent

  1. bmqa_queueid
..

/Component Synopsis
/------------------
: 'bmqa_event':
:      Provide a generic variant encompassing all types of events.
:
: 'bmqa_message':
:      Provide the application with a message data object.
:
: 'bmqa_messageevent':
:      Provide the application with data event notifications.
:
: 'bmqa_messageeventbuilder':
:      Provide a builder for 'MessageEvent' objects.
:
: 'bmqa_messageiterator':
:      Provide a mechanism to iterate over the messages of a MessageEvent.
:
: 'bmqa_openqueuestatus':
:      Provide value-semantic type for an open queue operation
:
: 'bmqa_closequeuestatus':
:      Provide value-semantic type for a close queue operation
:
: 'bmqa_configurequeuestatus':
:      Provide value-semantic type for a configure queue operation
:
: 'bmqa_queueid':
:      Provide a value-semantic efficient identifier for a queue.
:
: 'bmqa_session':
:      Provide access to the BlazingMQ broker.
:
: 'bmqa_sessionevent':
:      Provide value-semantic type for system event session notifications.