ec_throttle_time_until_clear

March 26, 2020 Contributors

Name

ec_throttle_time_until_clear — check to see how long it will be until a throttle is under budget

Synopsis

#include "throttle.h"

| int **ec_throttle_time_until_clear** ( | name); |   |

const char * <var class="pdparam">name</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.

check to see how long it will be until a throttle is under budget

A simpler to use variant of ec_throttle_is_exceeded, this function will return the number of seconds until the throttle will be under budget, or 0 if it is currently under budget.

Parameters

name

the name of the throttle

Return Values

the number of seconds until the throttle is under budget

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