inbox.h File Reference

Go to the source code of this file.

Typedefs
typedef void(MAMACALLTYPE *	mamaInboxMsgCallback) (mamaMsg msg, void *closure)
	Inbox structure for processing point to point messaging. More...
typedef void(MAMACALLTYPE *	mamaInboxErrorCallback) (mama_status status, void *closure)
	NB. More...
typedef void(MAMACALLTYPE *	mamaInboxDestroyCallback) (mamaInbox inbox, void *closure)
	Invoked whenever the inbox has been destroyed. More...

Functions
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

mamaInboxMsgCallback

typedef void(MAMACALLTYPE * mamaInboxMsgCallback) (mamaMsg msg, void *closure)

Inbox structure for processing point to point messaging.

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()

mamaInboxErrorCallback

typedef void(MAMACALLTYPE * mamaInboxErrorCallback) (mama_status status, void *closure)

NB.

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()

mamaInboxDestroyCallback

typedef void(MAMACALLTYPE * mamaInboxDestroyCallback) (mamaInbox inbox, void *closure)

Invoked whenever the inbox has been destroyed.

Parameters

inbox	The mama inbox.
closure	The user supplied data passed to mamaInbox_create()

Function Documentation

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

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.

mamaInbox_create2()

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

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.

mamaInbox_destroy()

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

inbox

The mamaInbox to be destroyed.

Returns

mama_Status MAMA_STATUS_OK if function call successful.