[#BloombergLP-bdlmt-Throttle-initialize-03]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlmt.adoc[bdlmt]::xref:BloombergLP/bdlmt/Throttle.adoc[Throttle]::initialize
:relfileprefix: ../../../
:mrdocs:

`initialize` overloads

== Synopses

Declared in `<bdlmt_throttle.h>`

Initialize this throttle with the specified rate and burst limits.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
xref:BloombergLP/bdlmt/Throttle/initialize-09.adoc[initialize](
    int maxSimultaneousActions,
    xref:BloombergLP/bdlmt/Throttle.adoc[Int64] nanosecondsPerAction,
    xref:BloombergLP/bsls/SystemClockType/Enum.adoc[bsls::SystemClockType::Enum] clockType = bsls::SystemClockType::e_MONOTONIC);
----

[.small]#xref:BloombergLP/bdlmt/Throttle/initialize-09.adoc[_» more..._]#

Initialize this throttle using the monotonic clock and specified limits.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
xref:BloombergLP/bdlmt/Throttle/initialize-0f.adoc[initialize](
    int maxSimultaneousActions,
    xref:BloombergLP/bdlmt/Throttle.adoc[Int64] nanosecondsPerAction,
    std::chrono::steady_clock const& clock);
----

[.small]#xref:BloombergLP/bdlmt/Throttle/initialize-0f.adoc[_» more..._]#

Initialize this throttle using the realtime clock and specified limits.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
xref:BloombergLP/bdlmt/Throttle/initialize-0d.adoc[initialize](
    int maxSimultaneousActions,
    xref:BloombergLP/bdlmt/Throttle.adoc[Int64] nanosecondsPerAction,
    std::chrono::system_clock const& clock);
----

[.small]#xref:BloombergLP/bdlmt/Throttle/initialize-0d.adoc[_» more..._]#

== Parameters

[cols="1,4"]
|===
| Name| Description
| *maxSimultaneousActions*
| maximum actions allowed at one time
| *nanosecondsPerAction*
| minimum average period between actions
| *clockType*
| system clock used to measure time
| *clock*
| unused; selects the monotonic system clock
|===


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