BloombergLP::bdlmt::ThreadPool::ThreadPool

Construct a thread pool with TimeInterval idle time and a name.

Synopsis

Declared in <bdlmt_threadpool.h>

ThreadPool(
    bslmt::ThreadAttributes const& threadAttributes,
    int minThreads,
    int maxThreads,
    bsls::TimeInterval maxIdleTime,
    std::string_view const& threadPoolName,
    bdlm::MetricsRegistry* metricsRegistry,
    bslma::Allocator* basicAllocator = 0);

Description

Construct a thread pool with the specified threadAttributes, the specified minThreads minimum number of threads, the specified maxThreads maximum number of threads, the specified maxIdleTime idle time after which a thread may be considered for destruction, the specified threadPoolName to be used to identify this thread pool, 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 name used for created threads is threadAttributes.threadName() if not empty, otherwise threadPoolName if not empty, otherwise "bdl.ThreadPool". The behavior is undefined unless 0 <= minThreads, minThreads <= maxThreads, 0 <= maxIdleTime, and the maxIdleTime has a value less than or equal to INT_MAX milliseconds.

Parameters

NameDescription
threadAttributesattributes used when creating worker threads
minThreadsminimum number of worker threads
maxThreadsmaximum number of worker threads
maxIdleTimeidle time before a thread may exit
threadPoolNamename identifying this thread pool
metricsRegistrymetrics registry, or singleton if 0
basicAllocatormemory allocator; null uses the default