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

Construct a token bucket with a given rate, initial balance, and capacity.

== Synopsis

Declared in `<util/tokenbucket.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
TokenBucket(
    double rate,
    double value,
    double cap);
----

== Parameters

[cols="1,4"]
|===
| Name| Description
| *rate*
| Tokens added per second.
| *value*
| Initial token balance (clamped to cap).
| *cap*
| Maximum token balance.
|===


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