solClient_session_rxMsgDispatchFuncInfo Struct Reference

Callback information for Session message receive dispatch. More...

#include <solClient.h>

Data Fields
solClient_dispatchType_t	dispatchType
	The type of dispatch described. More...
solClient_session_rxMsgCallbackFunc_t	callback_p
	An application-defined callback function; may be NULL in which case the default session receive message callback is used. More...
void *	user_p
	A user pointer to return with the callback; must be NULL if callback_p is NULL. More...
void *	rfu_p
	Reserved for Future use; must be NULL. More...

Detailed Description

Callback information for Session message receive dispatch.

This can be set on a per-subscription basis. This structure is passed to solClient_session_topicSubscribeWithDispatch and solClient_session_topicUnsubscribeWithDispatch.

An application may create multiple solClient_session_rxMsgDispatchFuncInfo with different callback functions or different user pointers or both, to define alternate processing for incoming messages based on subscription used to attract the messages.

Through the use of wildcards, multiple unique subscriptions may match the same received messages, for example messages received on topic a/b will match subscriptions to a/> and a/b. In this case both dispatches are invoked on the message.

Examples:

ex/ios/examples/TopicDispatchExample.m, and ex/topicDispatch.c.

Field Documentation

solClient_session_rxMsgCallbackFunc_t callback_p

An application-defined callback function; may be NULL in which case the default session receive message callback is used.

Examples:

ex/ios/examples/TopicDispatchExample.m, and ex/topicDispatch.c.

solClient_dispatchType_t dispatchType

The type of dispatch described.

void* rfu_p

Reserved for Future use; must be NULL.

void* user_p

A user pointer to return with the callback; must be NULL if callback_p is NULL.

Examples:

ex/ios/examples/TopicDispatchExample.m, and ex/topicDispatch.c.