Consume n tokens. Returns false if the balance dropped to/below the given floor.

Synopsis

Declared in <util/tokenbucket.h>

bool
decrement(
    double n = 1.0,
    double floor = 0.0);

Return Value

true if the remaining balance is still above floor.

Parameters

Name

Description

n

The number of tokens to consume.

floor

The balance threshold below which consumption is reported as failed.

Created with MrDocs