[Contents] [Prev] [Next] [Index] [Report an Error]

jcs:dampen() Function

The jcs:dampen() function is used to limit the number of times a function is called in succession when using a script. If a specific function exceeds the maximum number of calls within a specified amount of time, the jcs:dampen() function returns false. If a function does not exceed the maximum number of calls within a specified amount of time, the function returns true.

The function syntax is as follows:



var $rc jcs:dampen($tag, max, frequency);

Where:

$rc—Returned value based on the number of calls within a specified amount of time. If the number of calls exceeds the maximum number allowed, the value is false. If the number of calls is less than the maximum number allowed, the value is true.
$tag—The function call measured.
max—The maximum number of function calls allowed. This maximum number is based on the number of calls within a specified time interval (frequency).
frequency—The time interval, in minutes,

The following example shows how the dampen() function can be used:



if (jcs:dampen('my-change', 3, 10)) {
     /* Code to handle situations where the my-change function */
     /*  is called more than 3 times within 10 minutes */
} else {
     /* Code to handle all other cases */

[Contents] [Prev] [Next] [Index] [Report an Error]