Managing topic subscriptions.

Functions
CONVERSATION_ID_T *	missing_topic_register_handler (SESSION_T *session, const MISSING_TOPIC_PARAMS_T params)
	Register to receive notifications about missing topics that clients attempt to fetch/subscribe. More...
void	missing_topic_deregister_handler (SESSION_T *session, const CONVERSATION_ID_T *conversation_id)
	Cease receiving missing topic notifications. More...
void	missing_topic_proceed (SESSION_T *session, SVC_MISSING_TOPIC_REQUEST_T *request)
	Proceed (retry) after a processing a missing topic notification. More...
void	missing_topic_cancel (SESSION_T *session, SVC_MISSING_TOPIC_REQUEST_T *request)
	Cancel the operation leading to this missing topic notification. More...
void	notify_subscription_register (SESSION_T *session, const NOTIFY_SUBSCRIPTION_PARAMS_T params)
	Register to receive subscription notifications. More...
void	notify_unsubscription_register (SESSION_T *session, const NOTIFY_UNSUBSCRIPTION_PARAMS_T params)
	Register to receive unsubscription notifications. More...
void	subscribe_client (SESSION_T *session, const SUBSCRIPTION_CONTROL_PARAMS_T params)
	Subscribe a session to topics. More...
void	unsubscribe_client (SESSION_T *session, const SUBSCRIPTION_CONTROL_PARAMS_T params)
	Unsubscribe a session from topics. More...

Detailed Description

Function Documentation

void missing_topic_cancel	(	SESSION_T *	session,
		SVC_MISSING_TOPIC_REQUEST_T *	request
	)

Cancel the operation leading to this missing topic notification.

To be called in a missing topic notification handler, this notifies Diffusion that it should not continue processing the original request.

Parameters

session	The current session.
request	The request which gave rise to the missing topic notification.

void missing_topic_deregister_handler	(	SESSION_T *	session,
		const CONVERSATION_ID_T *	conversation_id
	)

Cease receiving missing topic notifications.

Parameters

session	The current session. If NULL, this function returns immediately.
conversation_id	The conversation id returned from a previous call to missing_topic_register_handler().

void missing_topic_proceed	(	SESSION_T *	session,
		SVC_MISSING_TOPIC_REQUEST_T *	request
	)

Proceed (retry) after a processing a missing topic notification.

To be called in a missing topic notification handler, this notifies Diffusion that it may complete processing of the original request.

Parameters

session	The current session.
request	The request which gave rise to the missing topic notification.

CONVERSATION_ID_T* missing_topic_register_handler	(	SESSION_T *	session,
		const MISSING_TOPIC_PARAMS_T	params
	)

Register to receive notifications about missing topics that clients attempt to fetch/subscribe.

Register a handler for receiving missing topic notifications when a client attempts to fetch or subscribe to a topic underneath a given root topic, but that requested topic doesn't exist.

Parameters

session	The current session. If NULL, this function returns immediately with the value NULL.
params	Parameters defining the registration request.

Returns

A conversation id that can be used to deregister the handler at a later time, or NULL if the supplied session is NULL.

void notify_subscription_register	(	SESSION_T *	session,
		const NOTIFY_SUBSCRIPTION_PARAMS_T	params
	)

Register to receive subscription notifications.

This function should be called by the application to register to receive notifications that it has been subscribed to a topic.

Parameters

session	The current session. If NULL, this function returns immediately.
params	Callbacks and other parameters. on_notify_subscription should be set to receive notifications.

void notify_unsubscription_register	(	SESSION_T *	session,
		const NOTIFY_UNSUBSCRIPTION_PARAMS_T	params
	)

Register to receive unsubscription notifications.

This function should be called by the application to receive notifications that it has been unsubscribed to a topic.

Parameters

session	The current session. If NULL, this function returns immediately.
params	Callbacks and other parameters. on_notify_unsubscription should be set to receive notifications.

void subscribe_client	(	SESSION_T *	session,
		const SUBSCRIPTION_CONTROL_PARAMS_T	params
	)

Subscribe a session to topics.

This function requests that a client is subscribed to the topics specified by a topic selector.

Parameters

session	The session handle. If NULL, this function returns immediately.
params	Parameters describing the subscription control request and callback handlers which may be invoked in response.

void unsubscribe_client	(	SESSION_T *	session,
		const SUBSCRIPTION_CONTROL_PARAMS_T	params
	)

Unsubscribe a session from topics.

This function requests that a client is unsubscribed from the topics specified by a topic selector.

Parameters

session	The session handle. If NULL, this function returns immediately.
params	Parameters describing the subscription control request and callback handlers which may be invoked in response.