Diffusion C API  6.3.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Sending pings and responding to ping request.

Functions

void ping_system_register_handler (SESSION_T *session, const PING_SYSTEM_PARAMS_T params)
 Register a user-defined handler for system pings. More...
 
void ping_user_register_handler (SESSION_T *session, const PING_USER_PARAMS_T params)
 Register a user-defined handler for user pings. More...
 
void ping_user (SESSION_T *session, const PING_USER_PARAMS_T params)
 Explicitly send a user ping to Diffusion. More...
 

Detailed Description

Function Documentation

void ping_system_register_handler ( SESSION_T session,
const PING_SYSTEM_PARAMS_T  params 
)

Register a user-defined handler for system pings.

If you don't register a handler, then the default behaviour is to automatically respond to the ping.

The handler can be removed by passing the handlers with the on_ping_request function set to NULL.

Parameters
sessionA session handle. If NULL, this function returns immediately.
paramsCallbacks and other parameters. on_ping_request should be set.
void ping_user ( SESSION_T session,
const PING_USER_PARAMS_T  params 
)

Explicitly send a user ping to Diffusion.

Parameters
sessionA session handle. If NULL, this function returns immediately.
paramsCallbacks and other parameters. on_ping_response should be set.
void ping_user_register_handler ( SESSION_T session,
const PING_USER_PARAMS_T  params 
)

Register a user-defined handler for user pings.

If you don't register a handler, then the default behaviour is to automatically respond to the ping.

The handler can be removed by passing the handlers with the on_ping_request function set to NULL.

Parameters
sessionA session handle. If NULL, this function returns immediately.
paramsCallbacks and other parameters.link PING_USER_PARAMS_T on_ping_request} should be set.