client-control.h File Reference

Client control feature. More...

Data Structures
struct	session_properties_event_s
struct	session_properties_registration_handlers_s
struct	session_properties_registration_params_s
struct	svc_get_session_properties_response_s
struct	get_session_properties_params_s

Typedefs
typedef int(*	on_session_properties_event_cb )(SESSION_T *session, const SESSION_PROPERTIES_EVENT_T *event, void *context)
	Callbacks for session open/close and property updates have this function signature. More...

Enumerations
enum	SESSION_PROPERTIES_EVENT_TYPE_T { SESSION_PROPERTIES_EVENT_TYPE_OPEN, SESSION_PROPERTIES_EVENT_TYPE_UPDATE, SESSION_PROPERTIES_EVENT_TYPE_CLOSE, SESSION_PROPERTIES_EVENT_TYPE_DISCONNECTED }
enum	SESSION_PROPERTIES_UPDATE_TYPE_T { SESSION_PROPERTIES_UPDATE_TYPE_UPDATED, SESSION_PROPERTIES_UPDATE_TYPE_RECONNECTED, SESSION_PROPERTIES_UPDATE_TYPE_FAILED_OVER, SESSION_PROPERTIES_UPDATE_TYPE_DISCONNECTED }

Functions
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...

Detailed Description

Client control feature.

Typedef Documentation

typedef int(* on_session_properties_event_cb)(SESSION_T *session, const SESSION_PROPERTIES_EVENT_T *event, void *context)

Callbacks for session open/close and property updates have this function signature.

Enumeration Type Documentation

enum SESSION_PROPERTIES_EVENT_TYPE_T

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.

enum SESSION_PROPERTIES_UPDATE_TYPE_T

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.