Liberator Auth API  7.1.33.251325-ac556235
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.
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.

Generated on Fri May 24 2024 16:30:46 for Liberator Auth API