This class provides a mechanism for facilitating the use of multiple threads to perform various user‐defined functions ("jobs") when some degree of collaboration between threads is required. The thread multiplexor is configured with a total number of "processors", representing the number of threads that may process jobs at any particular time. Additional threads enqueue jobs to a pending job queue, which is processed by the next available processing thread.

Synopsis

Declared in <bdlmt_threadmultiplexor.h>

class ThreadMultiplexor;

Type Aliases

Name

Description

Job

A callback of this type may be passed to the processJob method.

Member Functions

Name

Description

ThreadMultiplexor [constructor]

Create a thread multiplexor which uses, at most, the specified maxProcessors number of threads to process user‐specified jobs, identified as callbacks of type Job. Jobs that cannot be processed immediately are placed on a queue having the specified maxQueueSize to be processed by the next free thread. 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 < maxProcessors and 0 < maxQueueSize.

~ThreadMultiplexor [destructor]

Destroy this thread multiplexor object.

maxProcessors

Return the maximum number of active processors.

numProcessors

Return the current number of active processors.

processJob

Process the specified job functor in the calling thread if the current number of processors is less than the maximum number of processors. Otherwise, enqueue job to the pending job queue. Return 0 on success, and a non‐zero value otherwise. Note that the only requirements on t_JOBTYPE are that it defines operator(), having a void return type, and that it defines a copy constructor.

operator BloombergLP::bslmf::NestedTraitDeclaration<ThreadMultiplexor, UsesBslmaAllocator>

Declare that this type uses a bslma allocator.

Created with MrDocs