Throttling configuration

These Liberator configuration items define the settings of Liberator's throttling feature. Throttling enables you to reduce the performance impact of high update rates by merging updates together.

Throttling is enabled by default - see object-throttle-off.

Tip: You can also use Liberator's bursting feature to to smooth peaks in data rates.

Contents

object-throttle-default-level

object-throttle-default-level specifies the throttle level that all users start at when they log in to Liberator. This is an index to the array of throttle times specified in the object-throttle-times array, or in the throttle-times array of add-object. The index starts at 0.

Syntax: object-throttle-default-level <parameter>

Type: integer

Default value: 0 (the first level specified in the object-throttle-times array, or in the throttle-times array of add-object)

object-throttle-off

object-throttle-off turns off Liberator's throttling capability when set to TRUE.

By default, throttling's enabled on all Liberator objects, with a default throttle time of 1 second. Use object-throttle-off to permanently turn throttling off.

Syntax: object-throttle-off <boolean>

Type: boolean

Default value: FALSE (throttling is enabled)

object-throttle-time

object-throttle-time is an alias for object-throttle-times.

Syntax: object-throttle-time time-1 time-2 time-3 ...

Type: array of floats and strings

Default value: one entry of 1.0 seconds

object-throttle-times

object-throttle-times specifies an array of throttle times in seconds that apply to all objects, except those overidden by the throttle-times option of add-object. If the object specifies a hierarchy of child objects (for example, it's a directory object), the throttle times apply to the children as well.

By default, throttling's enabled on all Liberator objects, with a throttle time of 1 second. To permanently turn it off, set object-throttle-off to TRUE.

Syntax: object-throttle-time time-1 time-2 time-3 ...

Type: array of floats and strings

Default value: one entry of 1.0 seconds

Values accepted:

Acceptable values are positive decimal numbers, 0,  stoppedpaused. The array must be in ascending order of throttle times, and if you use stopped or paused, it must be the last entry in the array.  Setting the level to stopped or paused means that clients are allowed to pause objects, therefore receiving no updates until the object is unpaused.


See also: