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

Namespace for multithreaded timer and event scheduling components.

== Types

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlmt/EventScheduler.adoc[`EventScheduler`] 
| Thread‐safe scheduler that dispatches callbacks on a worker thread.
| xref:BloombergLP/bdlmt/EventSchedulerEventHandle.adoc[`EventSchedulerEventHandle`] 
| Objects of this type refer to events in the `EventScheduler` API. They are convertible to `const Event*` references and may be used in any method that expects them.
| xref:BloombergLP/bdlmt/EventSchedulerRecurringEventHandle.adoc[`EventSchedulerRecurringEventHandle`] 
| Handle referring to a recurring event in an `EventScheduler`.
| xref:BloombergLP/bdlmt/EventSchedulerTestTimeSource.adoc[`EventSchedulerTestTimeSource`] 
| Test utility that controls the clock used by an `EventScheduler`.
| xref:BloombergLP/bdlmt/EventSchedulerTestTimeSource_Data.adoc[`EventSchedulerTestTimeSource_Data`] 
| Component‐private implementation of test time‐source state.
| xref:BloombergLP/bdlmt/FixedThreadPool.adoc[`FixedThreadPool`] 
| This class implements a thread pool used for concurrently executing multiple user‐defined functions ("jobs").
| xref:BloombergLP/bdlmt/MultiQueueThreadPool.adoc[`MultiQueueThreadPool`] 
| This class implements a dynamic, configurable pool of queues, each of which is processed serially by a thread pool.
| xref:BloombergLP/bdlmt/MultiQueueThreadPool_Queue.adoc[`MultiQueueThreadPool_Queue`] 
| This private class provides a thread‐safe, lightweight job queue.
| xref:BloombergLP/bdlmt/MultipriorityThreadPool.adoc[`MultipriorityThreadPool`] 
| Thread pool that executes jobs according to integral priorities.
| xref:BloombergLP/bdlmt/Signaler.adoc[`Signaler`] 
| Thread‐safe signaler that invokes connected slots via its call operator.
| xref:BloombergLP/bdlmt/SignalerConnection.adoc[`SignalerConnection`] 
| Lightweight handle representing a signaler‐to‐slot connection.
| xref:BloombergLP/bdlmt/SignalerConnectionGuard.adoc[`SignalerConnectionGuard`] 
| RAII guard that disconnects a `SignalerConnection` on destruction.
| xref:BloombergLP/bdlmt/Signaler_ArgumentType.adoc[`Signaler_ArgumentType`] 
| Provide convenient forwarding types for each argument of `t_PROT`.
| xref:BloombergLP/bdlmt/Signaler_Invocable-03.adoc[`Signaler_Invocable`] 
| Provides a call operator for the derived class `bdlmt::Signaler`, such that its call signature is identical to that of `t_PROT`.
| xref:BloombergLP/bdlmt/Signaler_Node.adoc[`Signaler_Node`] 
| Shared implementation object backing a `Signaler`.
| xref:BloombergLP/bdlmt/Signaler_NotArg.adoc[`Signaler_NotArg`] 
| Provides a "Not an Argument" tag type.
| xref:BloombergLP/bdlmt/Signaler_SlotNode.adoc[`Signaler_SlotNode`] 
| Dynamically allocated container holding one connected slot.
| xref:BloombergLP/bdlmt/Signaler_SlotNode_Base.adoc[`Signaler_SlotNode_Base`] 
| Non‐template protocol base for `Signaler_SlotNode`.
| xref:BloombergLP/bdlmt/ThreadMultiplexor.adoc[`ThreadMultiplexor`] 
| Mechanism that partitions threads to process user‐defined jobs.
| xref:BloombergLP/bdlmt/ThreadPool.adoc[`ThreadPool`] 
| This class implements a thread pool used for concurrently executing multiple user‐defined functions ("jobs").
| xref:BloombergLP/bdlmt/ThreadPoolWaitNode.adoc[`ThreadPoolWaitNode`] 
| Component‐private node for the LIFO wait list of idle worker threads.
| xref:BloombergLP/bdlmt/Throttle.adoc[`Throttle`] 
| Mechanism that regulates the frequency at which actions may be taken.
| xref:BloombergLP/bdlmt/Throttle_InitHelper.adoc[`Throttle_InitHelper`] 
| Private helper that validates compile‐time throttle initialization arguments.
| xref:BloombergLP/bdlmt/TimerEventScheduler.adoc[`TimerEventScheduler`] 
| Thread‐safe scheduler that dispatches one‐shot and recurring callbacks.
| xref:BloombergLP/bdlmt/TimerEventSchedulerDispatcher.adoc[`TimerEventSchedulerDispatcher`] 
| Dispatcher functor type for `TimerEventScheduler`.
| xref:BloombergLP/bdlmt/TimerEventSchedulerTestTimeSource.adoc[`TimerEventSchedulerTestTimeSource`] 
| Test helper that substitutes a controllable clock into a timer scheduler.
| xref:BloombergLP/bdlmt/TimerEventSchedulerTestTimeSource_Data.adoc[`TimerEventSchedulerTestTimeSource_Data`] 
| Test time‐source data for `TimerEventScheduler` (testing only).
|===


== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlmt/FixedThreadPoolJobFunc.adoc[`FixedThreadPoolJobFunc`] 
| This type declares the prototype for functions that are suitable to be specified `bdlmt::FixedThreadPool::enqueueJob`.
| xref:BloombergLP/bdlmt/ThreadPoolJobFunc.adoc[`ThreadPoolJobFunc`] 
| This type declares the prototype for functions that are suitable to be specified `bdlmt::FixedThreadPool::enqueueJob`.
|===


== Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlmt/ThreadPoolEntry.adoc[`ThreadPoolEntry`] 
| Entry point for processing threads.
| xref:BloombergLP/bdlmt/swap-05.adoc[`swap`] 
| Swap the contents of `a` and `b`.
| xref:BloombergLP/bdlmt/operator_eq.adoc[`operator==`] 
| Return `true` if `lhs` and `rhs` refer to the same slot.
| xref:BloombergLP/bdlmt/operator_not_eq.adoc[`operator!=`] 
| Return `true` if `lhs` and `rhs` do not refer to the same slot.
| xref:BloombergLP/bdlmt/operator_lt.adoc[`operator<`] 
| Return `true` if `lhs` is ordered before `rhs`.
| xref:BloombergLP/bdlmt/operator_le.adoc[`operator<=`] 
| Return `true` if `lhs` is ordered before or equal to `rhs`.
| xref:BloombergLP/bdlmt/operator_gt.adoc[`operator>`] 
| Return `true` if `lhs` is ordered after `rhs`.
| xref:BloombergLP/bdlmt/operator_ge.adoc[`operator>=`] 
| Return `true` if `lhs` is ordered after or equal to `rhs`.
|===



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