Diffusion C API  5.9.24
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Creating and removing topics.

Functions

void add_topic (SESSION_T *session, const ADD_TOPIC_PARAMS_T params)
 Add a topic to Diffusion. More...
 
void remove_topics (SESSION_T *session, const REMOVE_TOPICS_PARAMS_T params)
 Remove topics from Diffusion. More...
 
void session_wills_remove_topics (SESSION_T *session, const SESSION_WILLS_REMOVE_TOPIC_PARAMS_T params)
 Register a topic removal session will. More...
 
void topic_removal (SESSION_T *session, const TOPIC_REMOVAL_PARAMS_T params)
 Remove topics from Diffusion. More...
 

Detailed Description

Function Documentation

void add_topic ( SESSION_T session,
const ADD_TOPIC_PARAMS_T  params 
)

Add a topic to Diffusion.

Parameters
sessionThe current session. If NULL, this function returns immediately.
paramsParameter structure describing the topic to be added, its definition, initial content and callbacks to handle success or failure notifications.
void remove_topics ( SESSION_T session,
const REMOVE_TOPICS_PARAMS_T  params 
)

Remove topics from Diffusion.

Parameters
sessionThe current session. If NULL, this function returns immediately.
paramsParameter structure describing which topics to remove and callbacks to handle success or failure notifications.
void session_wills_remove_topics ( SESSION_T session,
const SESSION_WILLS_REMOVE_TOPIC_PARAMS_T  params 
)

Register a topic removal session will.

An application should call this function to register a session will, whereby the specified topics are removed on session disconnection.

Parameters
sessionThe current session. If NULL, this function returns immediately.
paramsParameters describing the session will registration request and the callback handlers which may be invoked in response.
void topic_removal ( SESSION_T session,
const TOPIC_REMOVAL_PARAMS_T  params 
)

Remove topics from Diffusion.

Send a request to remove one or more topics at the server. The topics to remove will depend upon the nature of the topic selector specified. If the selector does not have descendant pattern qualifiers (i.e. / or //), only those topics that exist at paths indicated by the selector will be removed and not their descendants. If a single / qualifier is specified, all descendants of the matching topic paths will be removed. If // is specified, all branches of the topic tree that match the selector (i.e topics at the selected paths and all descendants of the selected paths) will be removed.

Parameters
sessionThe current session. If NULL, this function returns immediately.
paramsParameter structure describing which topics to remove and callbacks to handle success or failure notifications.