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

Synopsis

Declared in <bdlmt_timereventscheduler.h>

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

Description

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.

Parameters

Name

Description

numEvents

minimum concurrent one‐shot events supported

numClocks

minimum concurrent clocks supported

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