Diffusion C API  6.3.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Receive notifications about changes to selected topics.

Functions

bool diffusion_topic_notification_registration_select (SESSION_T *session, const DIFFUSION_TOPIC_NOTIFICATION_REGISTRATION_PARAMS_T params, DIFFUSION_API_ERROR *api_error)
 Request to receive notifications for all topics matched by the provided selector. More...
 
bool diffusion_topic_notification_registration_deselect (SESSION_T *session, const DIFFUSION_TOPIC_NOTIFICATION_REGISTRATION_PARAMS_T params, DIFFUSION_API_ERROR *api_error)
 Request to stop receiving notifications for all topics matched by the given selector. More...
 
bool diffusion_topic_notification_add_listener (SESSION_T *session, const DIFFUSION_TOPIC_NOTIFICATION_LISTENER_T listener, DIFFUSION_API_ERROR *api_error)
 Register a listener to receive topic notifications. More...
 

Detailed Description

Function Documentation

bool diffusion_topic_notification_add_listener ( SESSION_T session,
const DIFFUSION_TOPIC_NOTIFICATION_LISTENER_T  listener,
DIFFUSION_API_ERROR api_error 
)

Register a listener to receive topic notifications.

Parameters
sessionThe current session. If NULL, this function returns immediately.
listenerThe listener to receive topic specification notifications
api_errorPopulated on API error. Can be NULL.
Returns
true if the operation was successful. False, otherwise. In this case, if a non-NULL api_error pointer has been provided, this will be populated with the error information and should be freed with diffusion_api_error_free.
bool diffusion_topic_notification_registration_deselect ( SESSION_T session,
const DIFFUSION_TOPIC_NOTIFICATION_REGISTRATION_PARAMS_T  params,
DIFFUSION_API_ERROR api_error 
)

Request to stop receiving notifications for all topics matched by the given selector.

Parameters
sessionThe session handle. If NULL, this function returns immediately.
paramsParameters defining the diffusion_topic_notification_registration_deselect request and notification callbacks.
api_errorPopulated on API error. Can be NULL.
Returns
true if the operation was successful. False, otherwise. In this case, if a non-NULL api_error pointer has been provided, this will be populated with the error information and should be freed with diffusion_api_error_free.
bool diffusion_topic_notification_registration_select ( SESSION_T session,
const DIFFUSION_TOPIC_NOTIFICATION_REGISTRATION_PARAMS_T  params,
DIFFUSION_API_ERROR api_error 
)

Request to receive notifications for all topics matched by the provided selector.

Parameters
sessionThe session handle. If NULL, this function returns immediately.
paramsParameters defining the diffusion_topic_notification_registration_select request and notification callbacks.
api_errorPopulated on API error. Can be NULL.
Returns
true if the operation was successful. False, otherwise. In this case, if a non-NULL api_error pointer has been provided, this will be populated with the error information and should be freed with diffusion_api_error_free.