OpenMAMA
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
inbox.h File Reference

Go to the source code of this file.

Typedefs

typedef voidclosure
 

Functions

typedef void (MAMACALLTYPE *mamaInboxMsgCallback)(mamaMsg msg
 Inbox structure for processing point to point messaging. More...
 
MAMAExpDLL mama_status mamaInbox_create (mamaInbox *inbox, mamaTransport transport, mamaQueue queue, mamaInboxMsgCallback msgCB, mamaInboxErrorCallback errorCB, void *closure)
 Creates an inbox and stores at the address specified by the calling client. More...
 
MAMAExpDLL mama_status mamaInbox_create2 (mamaInbox *inbox, mamaTransport transport, mamaQueue queue, mamaInboxMsgCallback msgCB, mamaInboxErrorCallback errorCB, mamaInboxDestroyCallback onInboxDestroyed, void *closure)
 Creates an inbox and stores at the address specified by the calling client. More...
 
MAMAExpDLL mama_status mamaInbox_destroy (mamaInbox inbox)
 Destroy the supplied inbox structure. More...
 

Typedef Documentation

typedef void* closure

Function Documentation

typedef void ( MAMACALLTYPE *  mamaInboxDestroyCallback)

Inbox structure for processing point to point messaging.

Invoked whenever the inbox has been destroyed.

NB.

Invoked in response to a p2p message being received.

Parameters
msgThe mamaMsg received in the p2p response.
closureThe user supplied data passed to mamaInbox_create()

Not currently used. Invoked when an error is encountered during p2p messaging.

Parameters
statusThe mama_status describing the error condition.
closureThe user supplied data passed to mamaInbox_create()
inboxThe mama inbox.
closureThe user supplied data passed to mamaInbox_create()
MAMAExpDLL mama_status mamaInbox_create ( mamaInbox inbox,
mamaTransport  transport,
mamaQueue  queue,
mamaInboxMsgCallback  msgCB,
mamaInboxErrorCallback  errorCB,
void closure 
)

Creates an inbox and stores at the address specified by the calling client.

Parameters
inboxPointer to the inbox which will be created
transportThe mamaTransport being used.
queueThe mamaQueue to use.
msgCBInvoked for any point to point responses.
errorCBFor future use. Not currently used.
closureUser supplied data to be passed back in callbacks.
Returns
mama_status MAMA_STATUS_OK if the function is successful.
MAMAExpDLL mama_status mamaInbox_create2 ( mamaInbox inbox,
mamaTransport  transport,
mamaQueue  queue,
mamaInboxMsgCallback  msgCB,
mamaInboxErrorCallback  errorCB,
mamaInboxDestroyCallback  onInboxDestroyed,
void closure 
)

Creates an inbox and stores at the address specified by the calling client.

Parameters
inboxPointer to the inbox which will be created
transportThe mamaTransport being used.
queueThe mamaQueue to use.
msgCBInvoked for any point to point responses.
errorCBFor future use. Not currently used.
closureUser supplied data to be passed back in callbacks.
Returns
mama_status MAMA_STATUS_OK if the function is successful.
MAMAExpDLL mama_status mamaInbox_destroy ( mamaInbox  inbox)

Destroy the supplied inbox structure.

Note that this function is asynchronous and is only guaranteed to have finished whenever the onInboxDestroyed function passed to the mamaInbox_create2 has been called.

Parameters
inboxThe mamaInbox to be destroyed.
Returns
mama_Status MAMA_STATUS_OK if function call successful.


© 2012 Linux Foundation