BloombergLP::bdlmt::TimerEventScheduler::TimerEventScheduler

Construct a named event scheduler with the given dispatcher and clock.

Synopsis

Declared in <bdlmt_timereventscheduler.h>

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

Description

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.

Parameters

Name

Description

dispatcherFunctor

functor that runs dispatched callbacks

clockType

clock used for time intervals

eventSchedulerName

name identifying this scheduler

metricsRegistry

metrics registry, or singleton if 0

basicAllocator

memory allocator; null uses the default

Created with MrDocs