Struct MeteringConfiguration 

pub struct MeteringConfiguration {
    pub threshold: u64,
    pub sleep_step: u64,
    pub expiry_time: NanoTimestamp,
}

Struct representing metering configuration parameters.

Fields

threshold: u64

Defines the threshold after which rate limit kicks in. Set to 0 for no threshold.

If we don’t use raw count as our metric, it should be calculated by multiplying the median increase of the measured item with the “max” number of items we want before rate limit starts. For example, if we measure some item that increases our total measurement by ~5 and want to rate limit after about 10, this should be set as 50.

sleep_step: u64

Sleep time for each unit over the threshold, in milliseconds.

This is used to calculate sleep time when ratelimit is active. The computed sleep time when we are over the threshold will be: sleep_time = (total - threshold) * sleep_step

expiry_time: NanoTimestamp

Parameter defining the expiration of each item, for time based decay, in nano seconds. Set to 0 for no expiration.

Implementations

impl MeteringConfiguration

pub fn new(threshold: u64, sleep_step: u64, expiry_time: u128) -> Self

Generate a new MeteringConfiguration for provided threshold, sleep step and expiration time (seconds).

Trait Implementations

impl Clone for MeteringConfiguration

fn clone(&self) -> MeteringConfiguration

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MeteringConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MeteringConfiguration

fn default() -> Self

Returns the “default value” for a type.