[#BloombergLP-balb-LeakyBucket-2constructor]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balb.adoc[balb]::xref:BloombergLP/balb/LeakyBucket.adoc[LeakyBucket]::LeakyBucket
:relfileprefix: ../../../
:mrdocs:

Create an empty leaky bucket with the specified rate and capacity.

== Synopsis

Declared in `<balb_leakybucket.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
LeakyBucket(
    xref:BloombergLP/bsls/Types/Uint64.adoc[bsls::Types::Uint64] drainRate,
    xref:BloombergLP/bsls/Types/Uint64.adoc[bsls::Types::Uint64] capacity,
    xref:BloombergLP/bsls/TimeInterval.adoc[bsls::TimeInterval] const& currentTime);
----

== Description

Create an empty leaky bucket having the specified `drainRate`, the specified `capacity`, and the specified `currentTime` as the initial `lastUpdateTime`. The behavior is undefined unless `0 < newRate`, `0 < newCapacity`, and `LLONG_MIN != currentTime.seconds()`.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *drainRate*
| rate at which units drain from the bucket
| *capacity*
| maximum number of units the bucket can hold
| *currentTime*
| initial `lastUpdateTime` for the bucket
|===


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