[#util-TokenBucket-decrement]
= xref:util.adoc[util]::xref:util/TokenBucket.adoc[TokenBucket]::decrement
:relfileprefix: ../../
:mrdocs:

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

== Synopsis

Declared in `<util/tokenbucket.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
bool
decrement(
    double n = 1.0,
    double floor = 0.0);
----

== Return Value

true if the remaining balance is still above floor.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *n*
| The number of tokens to consume.
| *floor*
| The balance threshold below which consumption is reported as failed.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#