svc-subscription-control.h File Reference

Functions for subscribing and unsubscribing connected clients from topics. More...

Data Structures
struct	svc_subscription_control_request_s
	Structure describing a subscription control request. More...
struct	svc_subscription_control_response_s
	Structure describing a subscription control response. More...
struct	subscription_control_params_s

Macros
#define	SUBSCRIPTION_CONTROL_HANDLERS
	Callback handlers that may be registered so the caller may receive notifcation that a subscription or unsubscription request has completed.

Typedefs
typedef struct svc_subscription_control_request_s	SVC_SUBSCRIPTION_CONTROL_REQUEST_T
	Structure describing a subscription control request.
typedef struct svc_subscription_control_response_s	SVC_SUBSCRIPTION_CONTROL_RESPONSE_T
	Structure describing a subscription control response.
typedef int(*	on_subscription_control_cb )(SESSION_T *session, void *context)
	Callback for subscribe_client() and unsubscribe_client(). More...

Functions
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

Functions for subscribing and unsubscribing connected clients from topics.

Typedef Documentation

typedef int(* on_subscription_control_cb)(SESSION_T *session, void *context)

Callback for subscribe_client() and unsubscribe_client().

Parameters

session	The current active session.
context	User-supplied context from the originating call.

Returns

HANDLER_SUCCESS or HANDLER_FAILURE.