[#BloombergLP-balb-RateLimiter-wouldExceedBandwidth]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balb.adoc[balb]::xref:BloombergLP/balb/RateLimiter.adoc[RateLimiter]::wouldExceedBandwidth
:relfileprefix: ../../../
:mrdocs:

Return whether submitting 1 unit at `currentTime` would exceed limits&period;

== Synopsis

Declared in `&lt;balb&lowbar;ratelimiter&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
bool
wouldExceedBandwidth(xref:BloombergLP/bsls/TimeInterval.adoc[bsls::TimeInterval] const& currentTime);
----

== Description

Update the state of this rate limiter to the specified `currentTime`&period; Return `true` if submitting 1 unit at the `currentTime` would exceed the configured limits, and false otherwise&period;

== Return Value

`true` if submitting 1 unit would exceed limits, else `false`

== Parameters

[cols="1,4"]
|===
| Name| Description
| *currentTime*
| time used to update this limiter before checking
|===


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