Diffusion C API
6.1.5
|
Functions | |
void | update_value (SESSION_T *session, const UPDATE_VALUE_PARAMS_T params) |
Update topic content. More... | |
void | update_value_with_datatype (SESSION_T *session, DIFFUSION_DATATYPE datatype, UPDATE_VALUE_PARAMS_T params) |
Update topic content. More... | |
CONVERSATION_ID_T * | register_update_source (SESSION_T *session, const UPDATE_SOURCE_REGISTRATION_PARAMS_T params) |
Register a topic update source. More... | |
void | deregister_update_source (SESSION_T *session, const UPDATE_SOURCE_DEREGISTRATION_PARAMS_T params) |
Deregister a topic update source. More... | |
void | update (SESSION_T *session, const UPDATE_SOURCE_PARAMS_T params) |
Update topic content. More... | |
void deregister_update_source | ( | SESSION_T * | session, |
const UPDATE_SOURCE_DEREGISTRATION_PARAMS_T | params | ||
) |
Deregister a topic update source.
Deregisters an existing update source from Diffusion.
session | The session handle. If NULL, this function returns immediately. |
params | Parameter structure describing the deregistration request. |
CONVERSATION_ID_T* register_update_source | ( | SESSION_T * | session, |
const UPDATE_SOURCE_REGISTRATION_PARAMS_T | params | ||
) |
Register a topic update source.
Registers an update source with Diffusion, requesting responsibility for managing topic state for all topics from a given point and below.
session | The session handle. If NULL, this function returns immediately with a NULL value. |
params | Parameter structure describing the registration request. |
void update | ( | SESSION_T * | session, |
const UPDATE_SOURCE_PARAMS_T | params | ||
) |
Update topic content.
Sends new topic content to Diffusion, for transmission to subscribed clients. Where possible, prefer update_value() to update().
session | The session handle. If NULL, this function returns immediately. |
params | Parameter structure describing which topic to update, the new content, how the update is to be applied, and callbacks to handle success or failure notifications. |
void update_value | ( | SESSION_T * | session, |
const UPDATE_VALUE_PARAMS_T | params | ||
) |
Update topic content.
Updates the content of a topic of a certain type (binary, JSON) but unlike update(), this may transparently send delta updates which require less network bandwidth. If possible, prefer this function to update().
session | The session handle. If NULL, this function returns immediately. |
params | Parameter structure describing which topic to update, the value that the topic on the server will contain and callbacks to handle success or failure notifications. |
void update_value_with_datatype | ( | SESSION_T * | session, |
DIFFUSION_DATATYPE | datatype, | ||
UPDATE_VALUE_PARAMS_T | params | ||
) |
Update topic content.
Updates the content of a topic of a provided datatype. This is the preferred function for updating datatype topics (Binary, JSON, String, Int64, Double and Recordv2)
session | The session handle. If NULL, this function returns immediately. |
datatype | DIFFUSION_DATATYPE of the topic to be updated. |
params | Parameter structure describing which topic to update, the value that the topic on the server will contain and callbacks to handle success or failure notifications. |