[#BloombergLP-bdlmt-TimerEventScheduler-2constructor-0e02]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlmt.adoc[bdlmt]::xref:BloombergLP/bdlmt/TimerEventScheduler.adoc[TimerEventScheduler]::TimerEventScheduler
:relfileprefix: ../../../
:mrdocs:

Constructors

== Synopses

Declared in `<bdlmt_timereventscheduler.h>`

Construct an event scheduler using the default dispatcher functor (see the "The dispatcher thread and the dispatcher functor" section in component‐level doc) and use the realtime clock epoch for all time intervals (see []Clock‐Types) ). Optionally specify a `basicAllocator` used to supply memory. If `basicAllocator` is 0, the currently installed default allocator is used. Note that the maximal number of scheduled non‐recurring events and recurring events defaults to an implementation defined constant.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
explicit
xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-01.adoc[TimerEventScheduler](xref:BloombergLP/bslma/Allocator.adoc[bslma::Allocator]* basicAllocator = 0);
----

[.small]#xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-01.adoc[_» more..._]#

Construct an event scheduler using the default dispatcher functor (see the "The dispatcher thread and the dispatcher functor" section in component‐level doc) and use the specified `clockType` to indicate the epoch used for all time intervals (see []Clock‐Types)). Optionally specify a `basicAllocator` used to supply memory. If `basicAllocator` is 0, the currently installed default allocator is used. Note that the maximal number of scheduled non‐recurring events and recurring events defaults to an implementation defined constant.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
explicit
xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-0e0c.adoc[TimerEventScheduler](
    xref:BloombergLP/bsls/SystemClockType/Enum.adoc[bsls::SystemClockType::Enum] clockType,
    xref:BloombergLP/bslma/Allocator.adoc[bslma::Allocator]* basicAllocator = 0);
----

[.small]#xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-0e0c.adoc[_» more..._]#

Construct an event scheduler using the specified `dispatcherFunctor` (see "The dispatcher thread and the dispatcher functor" section in component‐level doc) and use the realtime clock epoch for all time intervals (see []Clock‐Types)). Optionally specify a `basicAllocator` used to supply memory. If `basicAllocator` is 0, the currently installed default allocator is used. Note that the maximal number of scheduled non‐recurring events and recurring events defaults to an implementation defined constant.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
explicit
xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-0e2.adoc[TimerEventScheduler](
    xref:BloombergLP/bdlmt/TimerEventScheduler/Dispatcher.adoc[Dispatcher] const& dispatcherFunctor,
    xref:BloombergLP/bslma/Allocator.adoc[bslma::Allocator]* basicAllocator = 0);
----

[.small]#xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-0e2.adoc[_» more..._]#

Construct a timer event scheduler using the default dispatcher functor (see the "The dispatcher thread and the dispatcher functor" section in component level doc) that has the capability to concurrently schedule _at_ _least_ the specified `numEvents` and `numClocks` and use the realtime clock epoch for all time intervals (see []Clock‐Types)). Optionally specify a `basicAllocator` used to supply memory. If `basicAllocator` is 0, the currently installed default allocator is used. The behavior is undefined unless `0 <= numEvents < 2**24` and `0 <= numClocks < 2**24`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-04.adoc[TimerEventScheduler](
    int numEvents,
    int numClocks,
    xref:BloombergLP/bslma/Allocator.adoc[bslma::Allocator]* basicAllocator = 0);
----

[.small]#xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-04.adoc[_» more..._]#

Construct an event scheduler using the specified `dispatcherFunctor` (see "The dispatcher thread and the dispatcher functor" section in component‐level doc) and use the specified `clockType` to indicate the epoch used for all time intervals (see []Clock‐Types)). Optionally specify a `basicAllocator` used to supply memory. If `basicAllocator` is 0, the currently installed default allocator is used. Note that the maximal number of scheduled non‐recurring events and recurring events defaults to an implementation defined constant.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
explicit
xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-0ee.adoc[TimerEventScheduler](
    xref:BloombergLP/bdlmt/TimerEventScheduler/Dispatcher.adoc[Dispatcher] const& dispatcherFunctor,
    xref:BloombergLP/bsls/SystemClockType/Enum.adoc[bsls::SystemClockType::Enum] clockType,
    xref:BloombergLP/bslma/Allocator.adoc[bslma::Allocator]* basicAllocator = 0);
----

[.small]#xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-0ee.adoc[_» more..._]#

Construct an event scheduler using the default dispatcher functor (see the "The dispatcher thread and the dispatcher functor" section in component‐level doc), use the realtime clock epoch for all time intervals (see []Clock‐Types)), the specified `eventSchedulerName` to be used to identify this event scheduler, and the specified `metricsRegistry` to be used for reporting metrics. If `metricsRegistry` is 0, `bdlm::MetricsRegistry::singleton()` is used. Optionally specify a `basicAllocator` used to supply memory. If `basicAllocator` is 0, the currently installed default allocator is used. Note that the maximal number of scheduled non‐recurring events and recurring events defaults to an implementation defined constant.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
explicit
xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-009.adoc[TimerEventScheduler](
    std::string_view const& eventSchedulerName,
    xref:BloombergLP/bdlm/MetricsRegistry.adoc[bdlm::MetricsRegistry]* metricsRegistry,
    xref:BloombergLP/bslma/Allocator.adoc[bslma::Allocator]* basicAllocator = 0);
----

[.small]#xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-009.adoc[_» more..._]#

Construct an event scheduler using the default dispatcher functor (see the "The dispatcher thread and the dispatcher functor" section in component‐level doc), use the specified `clockType` to indicate the epoch used for all time intervals (see []#(Supported Clock‐Types)), the specified `eventSchedulerName` to be used to identify this event scheduler, and the specified `metricsRegistry` to be used for reporting metrics. If `metricsRegistry` is 0, `bdlm::MetricsRegistry::singleton()` is used. Optionally specify a `basicAllocator` used to supply memory. If `basicAllocator` is 0, the currently installed default allocator is used. Note that the maximal number of scheduled non‐recurring events and recurring events defaults to an implementation defined constant.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
explicit
xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-0b4.adoc[TimerEventScheduler](
    xref:BloombergLP/bsls/SystemClockType/Enum.adoc[bsls::SystemClockType::Enum] clockType,
    std::string_view const& eventSchedulerName,
    xref:BloombergLP/bdlm/MetricsRegistry.adoc[bdlm::MetricsRegistry]* metricsRegistry,
    xref:BloombergLP/bslma/Allocator.adoc[bslma::Allocator]* basicAllocator = 0);
----

[.small]#xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-0b4.adoc[_» more..._]#

Construct a timer event scheduler using the default dispatcher functor (see the "The dispatcher thread and the dispatcher functor" section in component level doc) that has the capability to concurrently schedule _at_ _least_ the specified `numEvents` and `numClocks` and use the specified `clockType` to indicate the epoch used for all time intervals (see []Clock‐Types)). Optionally specify a `basicAllocator` used to supply memory. If `basicAllocator` is 0, the currently installed default allocator is used. The behavior is undefined unless `0 <= numEvents < 2**24` and `0 <= numClocks < 2**24`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-0c.adoc[TimerEventScheduler](
    int numEvents,
    int numClocks,
    xref:BloombergLP/bsls/SystemClockType/Enum.adoc[bsls::SystemClockType::Enum] clockType,
    xref:BloombergLP/bslma/Allocator.adoc[bslma::Allocator]* basicAllocator = 0);
----

[.small]#xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-0c.adoc[_» more..._]#

Construct a timer event scheduler using the specified `dispatcherFunctor` (see "The dispatcher thread and the dispatcher functor" section in component level doc) that has the capability to concurrently schedule _at_ _least_ the specified `numEvents` and `numClocks` and use the realtime clock epoch for all time intervals (see []Clock‐Types)). Optionally specify a `basicAllocator` used to supply memory. If `basicAllocator` is 0, the currently installed default allocator is used. The behavior is undefined unless `0 <= numEvents < 2**24` and `0 <= numClocks < 2**24`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-0bd.adoc[TimerEventScheduler](
    int numEvents,
    int numClocks,
    xref:BloombergLP/bdlmt/TimerEventScheduler/Dispatcher.adoc[Dispatcher] const& dispatcherFunctor,
    xref:BloombergLP/bslma/Allocator.adoc[bslma::Allocator]* basicAllocator = 0);
----

[.small]#xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-0bd.adoc[_» more..._]#

Construct an event scheduler using the specified `dispatcherFunctor` (see "The dispatcher thread and the dispatcher functor" section in component‐level doc), use the realtime clock epoch for all time intervals (see []Clock‐Types)), the specified `eventSchedulerName` to be used to identify this event scheduler, and the specified `metricsRegistry` to be used for reporting metrics. If `metricsRegistry` is 0, `bdlm::MetricsRegistry::singleton()` is used. Optionally specify a `basicAllocator` used to supply memory. If `basicAllocator` is 0, the currently installed default allocator is used. Note that the maximal number of scheduled non‐recurring events and recurring events defaults to an implementation defined constant.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
explicit
xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-0a5.adoc[TimerEventScheduler](
    xref:BloombergLP/bdlmt/TimerEventScheduler/Dispatcher.adoc[Dispatcher] const& dispatcherFunctor,
    std::string_view const& eventSchedulerName,
    xref:BloombergLP/bdlm/MetricsRegistry.adoc[bdlm::MetricsRegistry]* metricsRegistry,
    xref:BloombergLP/bslma/Allocator.adoc[bslma::Allocator]* basicAllocator = 0);
----

[.small]#xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-0a5.adoc[_» more..._]#

Construct a timer event scheduler using the specified `dispatcherFunctor` (see "The dispatcher thread and the dispatcher functor" section in component level doc) that has the capability to concurrently schedule *at least* the specified `numEvents` and `numClocks` and use the specified `clockType` to indicate the epoch used for all time intervals (see []Clock‐Types)). Optionally specify a `basicAllocator` used to supply memory. If `basicAllocator` is 0, the currently installed default allocator is used. The behavior is undefined unless `0 <= numEvents < 2**24` and `0 <= numClocks < 2**24`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-0d.adoc[TimerEventScheduler](
    int numEvents,
    int numClocks,
    xref:BloombergLP/bdlmt/TimerEventScheduler/Dispatcher.adoc[Dispatcher] const& dispatcherFunctor,
    xref:BloombergLP/bsls/SystemClockType/Enum.adoc[bsls::SystemClockType::Enum] clockType,
    xref:BloombergLP/bslma/Allocator.adoc[bslma::Allocator]* basicAllocator = 0);
----

[.small]#xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-0d.adoc[_» more..._]#

Construct a timer event scheduler using the default dispatcher functor (see the "The dispatcher thread and the dispatcher functor" section in component level doc) that has the capability to concurrently schedule _at_ _least_ the specified `numEvents` and `numClocks`, use the realtime clock epoch for all time intervals (see []Clock‐Types)), the specified `eventSchedulerName` to be used to identify this event scheduler, and the specified `metricsRegistry` to be used for reporting metrics. If `metricsRegistry` is 0, `bdlm::MetricsRegistry::singleton()` is used. Optionally specify a `basicAllocator` used to supply memory. If `basicAllocator` is 0, the currently installed default allocator is used. The behavior is undefined unless `0 <= numEvents < 2**24` and `0 <= numClocks < 2**24`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-0f.adoc[TimerEventScheduler](
    int numEvents,
    int numClocks,
    std::string_view const& eventSchedulerName,
    xref:BloombergLP/bdlm/MetricsRegistry.adoc[bdlm::MetricsRegistry]* metricsRegistry,
    xref:BloombergLP/bslma/Allocator.adoc[bslma::Allocator]* basicAllocator = 0);
----

[.small]#xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-0f.adoc[_» more..._]#

Construct an event scheduler using the specified `dispatcherFunctor` (see "The dispatcher thread and the dispatcher functor" section in component‐level doc), use the specified `clockType` to indicate the epoch used for all time intervals (see []Clock‐Types)), the specified `eventSchedulerName` to be used to identify this event scheduler, and the specified `metricsRegistry` to be used for reporting metrics. If `metricsRegistry` is 0, `bdlm::MetricsRegistry::singleton()` is used. Optionally specify a `basicAllocator` used to supply memory. If `basicAllocator` is 0, the currently installed default allocator is used. Note that the maximal number of scheduled non‐recurring events and recurring events defaults to an implementation defined constant.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
explicit
xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-03.adoc[TimerEventScheduler](
    xref:BloombergLP/bdlmt/TimerEventScheduler/Dispatcher.adoc[Dispatcher] const& dispatcherFunctor,
    xref:BloombergLP/bsls/SystemClockType/Enum.adoc[bsls::SystemClockType::Enum] clockType,
    std::string_view const& eventSchedulerName,
    xref:BloombergLP/bdlm/MetricsRegistry.adoc[bdlm::MetricsRegistry]* metricsRegistry,
    xref:BloombergLP/bslma/Allocator.adoc[bslma::Allocator]* basicAllocator = 0);
----

[.small]#xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-03.adoc[_» more..._]#

Construct a timer event scheduler using the default dispatcher functor (see the "The dispatcher thread and the dispatcher functor" section in component level doc) that has the capability to concurrently schedule _at_ _least_ the specified `numEvents` and `numClocks`, use the specified `clockType` to indicate the epoch used for all time intervals (see []Clock‐Types) in the component documentation), the specified `eventSchedulerName` to be used to identify this event scheduler, and the specified `metricsRegistry` to be used for reporting metrics. If `metricsRegistry` is 0, `bdlm::MetricsRegistry::singleton()` is used. Optionally specify a `basicAllocator` used to supply memory. If `basicAllocator` is 0, the currently installed default allocator is used. The behavior is undefined unless `0 <= numEvents < 2**24` and `0 <= numClocks < 2**24`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-006.adoc[TimerEventScheduler](
    int numEvents,
    int numClocks,
    xref:BloombergLP/bsls/SystemClockType/Enum.adoc[bsls::SystemClockType::Enum] clockType,
    std::string_view const& eventSchedulerName,
    xref:BloombergLP/bdlm/MetricsRegistry.adoc[bdlm::MetricsRegistry]* metricsRegistry,
    xref:BloombergLP/bslma/Allocator.adoc[bslma::Allocator]* basicAllocator = 0);
----

[.small]#xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-006.adoc[_» more..._]#

Construct a timer event scheduler using the specified `dispatcherFunctor` (see "The dispatcher thread and the dispatcher functor" section in component level doc) that has the capability to concurrently schedule *at least* the specified `numEvents` and `numClocks`, use the realtime clock epoch for all time intervals (see []Clock‐Types)), the specified `eventSchedulerName` to be used to identify this event scheduler, and the specified `metricsRegistry` to be used for reporting metrics. If `metricsRegistry` is 0, `bdlm::MetricsRegistry::singleton()` is used. Optionally specify a `basicAllocator` used to supply memory. If `basicAllocator` is 0, the currently installed default allocator is used. The behavior is undefined unless `0 <= numEvents < 2**24` and `0 <= numClocks < 2**24`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-0be.adoc[TimerEventScheduler](
    int numEvents,
    int numClocks,
    xref:BloombergLP/bdlmt/TimerEventScheduler/Dispatcher.adoc[Dispatcher] const& dispatcherFunctor,
    std::string_view const& eventSchedulerName,
    xref:BloombergLP/bdlm/MetricsRegistry.adoc[bdlm::MetricsRegistry]* metricsRegistry,
    xref:BloombergLP/bslma/Allocator.adoc[bslma::Allocator]* basicAllocator = 0);
----

[.small]#xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-0be.adoc[_» more..._]#

Construct a timer event scheduler using the specified `dispatcherFunctor` (see "The dispatcher thread and the dispatcher functor" section in component level doc) that has the capability to concurrently schedule *at least* the specified `numEvents` and `numClocks`, use the specified `clockType` to indicate the epoch used for all time intervals (see []Clock‐Types)), the specified `eventSchedulerName` to be used to identify this event scheduler, and the specified `metricsRegistry` to be used for reporting metrics. If `metricsRegistry` is 0, `bdlm::MetricsRegistry::singleton()` is used. Optionally specify a `basicAllocator` used to supply memory. If `basicAllocator` is 0, the currently installed default allocator is used. The behavior is undefined unless `0 <= numEvents < 2**24` and `0 <= numClocks < 2**24`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-0a6.adoc[TimerEventScheduler](
    int numEvents,
    int numClocks,
    xref:BloombergLP/bdlmt/TimerEventScheduler/Dispatcher.adoc[Dispatcher] const& dispatcherFunctor,
    xref:BloombergLP/bsls/SystemClockType/Enum.adoc[bsls::SystemClockType::Enum] clockType,
    std::string_view const& eventSchedulerName,
    xref:BloombergLP/bdlm/MetricsRegistry.adoc[bdlm::MetricsRegistry]* metricsRegistry,
    xref:BloombergLP/bslma/Allocator.adoc[bslma::Allocator]* basicAllocator = 0);
----

[.small]#xref:BloombergLP/bdlmt/TimerEventScheduler/2constructor-0a6.adoc[_» more..._]#


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