Go to the source code of this file.
Functions |
typedef | void (MAMACALLTYPE *mamaInboxMsgCallback)(mamaMsg msg |
| Inbox structure for processing point to point messaging.
|
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.
|
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.
|
MAMAExpDLL mama_status | mamaInbox_destroy (mamaInbox inbox) |
| Destroy the supplied inbox structure.
|
Typedef Documentation
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
-
msg | The mamaMsg received in the p2p response. |
closure | The user supplied data passed to mamaInbox_create() |
Not currently used. Invoked when an error is encountered during p2p messaging.
- Parameters
-
status | The mama_status describing the error condition. |
closure | The user supplied data passed to mamaInbox_create() |
inbox | The mama inbox. |
closure | The user supplied data passed to mamaInbox_create() |
Creates an inbox and stores at the address specified by the calling client.
- Parameters
-
inbox | Pointer to the inbox which will be created |
transport | The mamaTransport being used. |
queue | The mamaQueue to use. |
msgCB | Invoked for any point to point responses. |
errorCB | For future use. Not currently used. |
closure | User supplied data to be passed back in callbacks. |
- Returns
- mama_status MAMA_STATUS_OK if the function is successful.
Creates an inbox and stores at the address specified by the calling client.
- Parameters
-
inbox | Pointer to the inbox which will be created |
transport | The mamaTransport being used. |
queue | The mamaQueue to use. |
msgCB | Invoked for any point to point responses. |
errorCB | For future use. Not currently used. |
closure | User supplied data to be passed back in callbacks. |
- Returns
- mama_status MAMA_STATUS_OK if the function is successful.
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
-
inbox | The mamaInbox to be destroyed. |
- Returns
- mama_Status MAMA_STATUS_OK if function call successful.