Throttling subscription updates

Functions
void	auth_listener_throttle (char *session_id, char *object_name, char *command)
	Throttle an individual subscription on a user's session. More...
void	auth_session_throttle (char *session_id, char *command)
	Throttle a users' session. More...

Detailed Description

Function Documentation

void auth_listener_throttle	(	char *	session_id,
		char *	object_name,
		char *	command
	)

Throttle an individual subscription on a user's session.

Parameters

session_id	- Session id to throttle
object_name	- The object name to throttle (this is the name of the object as seen by the client).
command	- Throttle command

Calling this method is the equivalent of a client application issuing the GlobalThrottle command

The command argument has the following values:

• up Increase the throttle (this will result in fewer updates being sent to the client).
• down Decrease the throttle (this will result in more updates being sent to the client).
• min Reduce the throttle level to the minimum.
• max Set the throttle level to the maximum.
• stop Stop any updates that could be throttled from being sent to client.
• start Restore the throttle level to the level that was applied prior to the stop command being issued.
• def Restore the throttle level to the configured default value.

References _session::application_id, auth_invalidate_sessions_by_name(), _session::id, infoob_add_int(), infoob_add_str(), MAX_OBNAME, MAX_USERNAME, _object::name, _user::ref, _logininfo::session_id, SESSION_ID_LEN_MAX, _session::user, and _user::username.

void auth_session_throttle	(	char *	session_id,
		char *	command
	)

Throttle a users' session.

Parameters

session_id	- Session id to throttle
command	- Throttle command

Calling this method is the equivalent of a client application issuing the GlobalThrottle command

The command argument has the following values:

• up Increase the throttle (this will result in fewer updates being sent to the client).
• down Decrease the throttle (this will result in more updates being sent to the client).
• min Reduce the throttle level to the minimum.
• max Set the throttle level to the maximum.
• stop Stop any updates that could be throttled from being sent to client.
• start Restore the throttle level to the level that was applied prior to the stop command being issued.
• def Restore the throttle level to the configured default value.

References SESSION_ID_LEN_MAX.