Whitebeam Template Reference Documentation

Whitebeam Template Reference Documentation

System Template

set()

See Also

rb.counter.()

Syntax

count = rb.counter.set(counterName, value, maxLifeTime)

Parameters

The 'set' method takes 3 parameters:

Name	Type/Value	Description
counterName	string	Required. A name that uniquely identifies this counter
value	number	Required. Initial value for this counter
maxLifeTime	number	Optional, default = 1800 Maximum time (in seconds) this variable will exist if it is not read or updated by the system. The default is 1800 (30 minutes).

Results

The 'set' method returns structure:

Type/Value	Range/Length	Description
struct count	see definition	Returns the modified counter.

Remarks

Set a counter to a specific value - forcing an overwrite of any existing value - creating the counter if it did not already exist.

return: The old value of the counter - or null if this request has created the counter.

Whitebeam release 1.3.36

(loadtime : 77ms)