BloombergLP::bdlmt::EventScheduler::EventScheduler

Create a named event scheduler using dispatcherFunctor and clockType.

Synopsis

Declared in <bdlmt_eventscheduler.h>

EventScheduler(
    Dispatcher const& dispatcherFunctor,
    bsls::SystemClockType::Enum clockType,
    std::string_view const& eventSchedulerName,
    bdlm::MetricsRegistry* metricsRegistry,
    bslma::Allocator* basicAllocator = 0);

Description

Create an event scheduler using the specified dispatcherFunctor (see {The Dispatcher Thread and the Dispatcher Functor} in the component-level documentation), using the specified clockType to indicate the epoch used for all time intervals (see {Supported 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.

Parameters

NameDescription
dispatcherFunctordispatcher callback
clockTypeclock used to interpret time intervals
eventSchedulerNamename identifying this scheduler
metricsRegistrymetrics registry, or singleton if 0
basicAllocatorallocator used to supply memory