Client control feature.
More...
|
void | session_properties_listener_register (SESSION_T *session, const SESSION_PROPERTIES_REGISTRATION_PARAMS_T params) |
| Register a listener for changes to other clients' properties. More...
|
|
void | get_session_properties (SESSION_T *session, const GET_SESSION_PROPERTIES_PARAMS_T params) |
| Request properties of a connected client. More...
|
|
bool | diffusion_set_session_properties (SESSION_T *session, const DIFFUSION_SET_SESSION_PROPERTIES_PARAMS_T params, DIFFUSION_API_ERROR *api_error) |
| Send a request to the server to change the user-defined session properties for a session. More...
|
|
bool | diffusion_set_session_properties_filter (SESSION_T *session, const DIFFUSION_SET_SESSION_PROPERTIES_FILTER_PARAMS_T params, DIFFUSION_API_ERROR *api_error) |
| Send a request to the server to set all sessions that satisfy a session filter with the new user-defined session properties. More...
|
|
bool | diffusion_change_roles_with_session_id (SESSION_T *session, const DIFFUSION_CHANGE_ROLES_WITH_SESSION_ID_PARAMS_T params, DIFFUSION_API_ERROR *api_error) |
| Changes the assigned roles of another session. More...
|
|
bool | diffusion_change_roles_with_filter (SESSION_T *session, const DIFFUSION_CHANGE_ROLES_WITH_FILTER_PARAMS_T params, DIFFUSION_API_ERROR *api_error) |
| Allows a session to change the assigned roles of all sessions that satisfy a given session filter. More...
|
|
typedef int(* change_roles_with_filter_cb)(int number_of_matching_sessions, void *context) |
Callback when a session's roles have been successfully changed.
- Parameters
-
number_of_matching_sessions | An integer value which represents a number of sessions that have matched the filter and for which the specified role changes have been applied. |
context | User supplied context. |
- Returns
- HANDLER_SUCCESS or HANDLER_FAILURE.
typedef int(* change_roles_with_session_id_cb)(void *context) |
Callback when a session's roles have been successfully changed.
- Parameters
-
context | User supplied context. |
- Returns
- HANDLER_SUCCESS or HANDLER_FAILURE.
Callbacks for session open/close and property updates have this function signature.
typedef int(* set_session_properties_cb)(const HASH_T *properties, void *context) |
Callback when a session's session properties have been set.
- Parameters
-
properties | A map of session properties that have changed. |
context | User supplied context. |
- Returns
- HANDLER_SUCCESS or HANDLER_FAILURE.
typedef int(* set_session_properties_filter_cb)(void *context) |
Callback when all sessions matching the filter have their session properties set.
- Parameters
-
context | User supplied context. |
- Returns
- HANDLER_SUCCESS or HANDLER_FAILURE.
Enumerator |
---|
SESSION_PROPERTIES_EVENT_TYPE_OPEN |
Indicates a session has been opened (e.g.
new client connection).
|
SESSION_PROPERTIES_EVENT_TYPE_UPDATE |
Indicates that a session has updated properties.
|
SESSION_PROPERTIES_EVENT_TYPE_CLOSE |
Indicates that a session has been closed.
|
SESSION_PROPERTIES_EVENT_TYPE_DISCONNECTED |
Indicates that a session has been disconnected.
|
Enumerator |
---|
SESSION_PROPERTIES_UPDATE_TYPE_UPDATED |
The session properties have been updated.
|
SESSION_PROPERTIES_UPDATE_TYPE_RECONNECTED |
The session properties have been updated due to reconnection with the server.
|
SESSION_PROPERTIES_UPDATE_TYPE_FAILED_OVER |
The session properties have been updated due to the session failing over to a different host.
|
SESSION_PROPERTIES_UPDATE_TYPE_DISCONNECTED |
Session has disconnected.
|