ec_adaptive_throttle_create_named

March 26, 2020 Contributors

Name

ec_adaptive_throttle_create_named — create a named throttle within the adaptive context

Synopsis

#include "modules/generic/adaptive.h"

| int **ec_adaptive_throttle_create_named** ( | name, |   |
|   | is_shared, |   |
|   | maximum, |   |
|   | time_period); |   |

const char * <var class="pdparam">name</var>;
int <var class="pdparam">is_shared</var>;
uint64_t <var class="pdparam">maximum</var>;
unsigned int <var class="pdparam">time_period</var>;

Description

Note

This reference page was automatically generated from functions found in the header files in the development branch. The function described here may not exist in generally available versions of Momentum, and may change in behavior when it is generally available. Consult your vendor for definitive advice on the use of this function.

create a named throttle within the adaptive context.

If is_shared is specified and in a cluster, the throttle will be shared within the cluster. Otherwise, it is equivalent to ec_throttle_create_named. This and other ec_adaptive_throttle_* are only intended for used in adaptive.lua to evaluate trigger rules!!! Creates a throttle that can be referenced by name.

Parameters

name

the name of the throttle

maximum

the upper bound of increments/events

time_period

number of seconds over which to enforce throttle

the

throttle should be shared

**Configuration Change. ** This feature is available starting from Momentum 3.3.