Pool of worker threads in a Reactor environment. More...

#include <tsReactiveWorkerPool.h>

Inheritance diagram for ts::ReactiveWorkerPool:

[legend]

Collaboration diagram for ts::ReactiveWorkerPool:

[legend]

Public Member Functions
	ReactiveWorkerPool (Reactor &reactor, Object *owner=nullptr)
	Constructor.

virtual	~ReactiveWorkerPool () override
	Destructor.

size_t	currentBusyThreads () const
	Get the current number of worker threads currently busy executing worker tasks.

size_t	currentThreads () const
	Get the current number of worker threads in the pool.

bool	isOwned ()
	Check if the object is owned.

template<class OBJECT > requires std::derived_from<OBJECT, ts::Object>
bool	isOwned ()
	Check if the object is owned by an object of a given type.

size_t	maxThreads () const
	Get the maximum number of worker threads in the pool.

bool	muteReport (bool mute)
	Temporarily mute the associated report.

Object *	owner ()
	Get the address of the optional "owner" object which was specified in the constructor.

template<class OBJECT > requires std::derived_from<OBJECT, ts::Object>
OBJECT *	owner ()
	Get the address of the "owner" object which was specified in the constructor.

Reactor &	reactor ()
	Get a reference to the associated reactor.

Report &	report () const
	Access the Report which is associated with this object.

void	setMaxThreads (size_t count)
	Set the maximum number of worker threads in the pool.

Report *	setReport (Report *report)
	Associate this object with another Report to log errors.

ReporterBase *	setReport (ReporterBase *delegate)
	Associate this object with another ReporterBase to log errors.

void	setStackSize (size_t size)
	Set the stack size in bytes of worker threads in the pool.

bool	signalQueuedOperations ()
	Trigger the execution of processQueuedOperations() in the context of a Reactor handler.

bool	startWork (ReactiveWorkerInterface work, ReactiveWorkerHandlerInterface handler, const ObjectPtr &user_data=ObjectPtr())
	Start a lengthy task in a delegated worker thread and return immediately.

void	waitForTermination (bool cancel_pending=false)
	Wait for all worker threads to become idle and terminate all worker threads.

Static Public Member Functions
static int	SilentLevel (bool silent)
	Compute a log severity level from a "silent" parameter.

Static Public Attributes
static constexpr size_t	DEFAULT_MAX_THREADS = 8
	Default maximum number of worker threads in the pool for newly created ReactiveWorkerPool instances.

Protected Member Functions
bool	createSignalQueuedOperations ()
	Create, if necessary, the dedicated user event for signalQueuedOperations().

void	deactivateQueuedOperations (bool silent)
	Deactivate the execution of processQueuedOperations() in the context of a Reactor handler.

virtual void	handleAsynchronousIO (Reactor &reactor, EventId id, NonBlockingDevice::IOSB &iosb, size_t io_size)
	Handle an asynchronous I/O completion event in a Reactor.

virtual void	handleBroadcastEvent (Reactor &reactor, int error_code, const ObjectPtr &user_data)
	Handle a broadcast event in a Reactor.

virtual void	handleReadReady (Reactor &reactor, EventId id, int error_code)
	Handle a read-ready event in a Reactor.

virtual void	handleTimer (Reactor &reactor, EventId id)
	Handle a timer in a Reactor.

virtual void	handleUserEvent (Reactor &, EventId) override
	Handle a user-defined event in a Reactor.

virtual void	handleWriteReady (Reactor &reactor, EventId id, int error_code)
	Handle a write-ready event in a Reactor.

virtual void	processQueuedOperations () override
	This virtual method processes operations in the context of a Reactor handler.

bool	uncheckedSignalQueuedOperations ()
	Trigger the execution of processQueuedOperations() from another thread.

Detailed Description

Pool of worker threads in a Reactor environment.

A Reactor event loop is a mono-thread synchronous environment. Each callback shall run without blocking I/O and without lengthy operations. When an application needs to run lengthy tasks in reactor callbacks, it must delegate these tasks in a worker thread. An instance of ReactiveWorkerPool can be used in association with a reactor to execute these lengthy tasks.

The instance of ReactiveWorkerPool is not thread-safe and should be used in the reactor thread only.

Constructor & Destructor Documentation

◆ ReactiveWorkerPool()

ts::ReactiveWorkerPool::ReactiveWorkerPool	(	Reactor &	reactor,
		Object *	owner = `nullptr`
	)

Constructor.

Parameters

[in,out]	reactor	Associated reactor. The reactor object must remain valid as long as this object is valid.
[in]	owner	Optional address of an "owner" object, typically an instance of class containing this object.

Member Function Documentation

◆ setMaxThreads()

void ts::ReactiveWorkerPool::setMaxThreads ( size_t count )

inline

Set the maximum number of worker threads in the pool.

This value only applies to future threads which will be created if the load increases. If the pool already started more threads, the number of active threads is not reduced. The default maximum number of worker threads in the pool for newly created ReactiveWorkerPool instances is DEFAULT_MAX_THREADS.

Parameters

[in] count Maximum number of worker threads in the pool.

◆ maxThreads()

size_t ts::ReactiveWorkerPool::maxThreads ( ) const

inline

Get the maximum number of worker threads in the pool.

Returns: The maximum number of worker threads in the pool.

◆ currentThreads()

size_t ts::ReactiveWorkerPool::currentThreads ( ) const

inline

Get the current number of worker threads in the pool.

Returns: The current number of worker threads in the pool. This is informational only.

◆ currentBusyThreads()

size_t ts::ReactiveWorkerPool::currentBusyThreads ( ) const

inline

Get the current number of worker threads currently busy executing worker tasks.

Returns: The current number of busy worker threads in the pool. This is informational only and can change at any time.

◆ setStackSize()

void ts::ReactiveWorkerPool::setStackSize ( size_t size )

inline

Set the stack size in bytes of worker threads in the pool.

This value only applies to future threads which will be created if the load increases. By default, the stack size of new threads depends on the operating system.

Parameters

[in] size Stack size in bytes of new worker threads in the pool. When zero, use the system default stack size.

See also: ThreadAttributes::setStackSize()

◆ startWork()

bool ts::ReactiveWorkerPool::startWork	(	ReactiveWorkerInterface *	work,
		ReactiveWorkerHandlerInterface *	handler,
		const ObjectPtr &	user_data = `ObjectPtr()`
	)

Start a lengthy task in a delegated worker thread and return immediately.

If a worker thread is idle, the work is immediately passed to it. Otherwise, if the maximum number of worker threads is not reached yet, a new worker thread is created to execute the work. Otherwise, the work is delayed until a worker thread becomes idle.

Parameters

[in]	work	An object instance which executes the work. Cannot be null.
[in]	handler	Handler class to call when the work completes. If nullptr, no handler is called.
[in]	user_data	A shared pointer which will be passed unmodified to work and handler.

Returns: True on success, false on error.

◆ waitForTermination()

void ts::ReactiveWorkerPool::waitForTermination ( bool cancel_pending = false )

Wait for all worker threads to become idle and terminate all worker threads.

Parameters

[in] cancel_pending If true, cancel works which are not started yet.

◆ processQueuedOperations()

virtual void ts::ReactiveWorkerPool::processQueuedOperations ( )

overrideprotectedvirtual

This virtual method processes operations in the context of a Reactor handler.

This is dedicated to operations which must be serialized from an application perspective. These operations are typically queued when triggered from a method which is called by the application. When the reactor processes events, we are sure that the application is not executing a handler. The default implementation does nothing. A subclass should override it if it calls signalQueuedOperations().

Reimplemented from ts::ReactiveBase.

◆ reactor()

Reactor & ts::ReactiveBase::reactor ( )

inlineinherited

Get a reference to the associated reactor.

Returns: A reference to the associated reactor.

◆ signalQueuedOperations()

bool ts::ReactiveBase::signalQueuedOperations ( )

inherited

Trigger the execution of processQueuedOperations() in the context of a Reactor handler.

Create if necessary and then signal a dedicated user event.

Returns: True on success, false on error.

◆ deactivateQueuedOperations()

void ts::ReactiveBase::deactivateQueuedOperations ( bool silent )

protectedinherited

Deactivate the execution of processQueuedOperations() in the context of a Reactor handler.

Deactivate and delete the dedicated user event.

Parameters

[in] silent If true, do not report errors through the logger.

◆ createSignalQueuedOperations()

bool ts::ReactiveBase::createSignalQueuedOperations ( )

protectedinherited

Create, if necessary, the dedicated user event for signalQueuedOperations().

Useless if signalQueuedOperations() is used. Only required with use of uncheckedSignalQueuedOperations().

Returns: True on success, false on error.

◆ uncheckedSignalQueuedOperations()

bool ts::ReactiveBase::uncheckedSignalQueuedOperations ( )

protectedinherited

Trigger the execution of processQueuedOperations() from another thread.

The event must have been previously created, either using createSignalQueuedOperations() or signalQueuedOperations().

Returns: True on success, false on error.

◆ handleUserEvent()

virtual void ts::ReactiveBase::handleUserEvent	(	Reactor &	reactor,
		EventId	id
	)

overrideprotectedvirtualinherited

Handle a user-defined event in a Reactor.

Parameters

[in,out]	reactor	Reactor into which the handler is invoked.
[in]	id	Id of the event which was signaled.

Reimplemented from ts::ReactorHandlerInterface.

◆ report()

Report & ts::ReporterBase::report ( ) const

inherited

Access the Report which is associated with this object.

Can be called from another thread only if the Report object is thread-safe.

Returns: A reference to the associated report.

◆ setReport() [1/2]

Report * ts::ReporterBase::setReport ( Report * report )

inherited

Associate this object with another Report to log errors.

Parameters

[in] report Where to report errors. The report object must remain valid as long as this object exists or setReport() is used with another Report object. If report is null, log messages are discarded.

Returns: The address of the previous Report object or a null pointer if there was none.

◆ setReport() [2/2]

ReporterBase * ts::ReporterBase::setReport ( ReporterBase * delegate )

inherited

Associate this object with another ReporterBase to log errors.

Parameters

[in] delegate Use the report of another ReporterBase. If delegate is null, the previous explicit Report is used..

Returns: The address of the previous ReporterBase object or a null pointer if there was none.

◆ muteReport()

bool ts::ReporterBase::muteReport ( bool mute )

inherited

Temporarily mute the associated report.

Parameters

[in] mute It true, report() will return a null report (log messages are discarded), until muteReport() is invoked again with mute set to false.

Returns: Previous state of the mute field.

◆ SilentLevel()

static int ts::ReporterBase::SilentLevel ( bool silent )

inlinestaticinherited

Compute a log severity level from a "silent" parameter.

Some subclass methods have a "silent" parameter to avoid reporting errors which may be insignificant, typically when closing a device after an error, in which case the close operation may produce other errors if the previous error left the device in an inconsistent state. While those errors should not be displayed as errors, we still display them at debug level.

Parameters

[in] silent If true, do not report errors, report debug messages instead.

Returns: Error when silent is false, Debug otherwise.

◆ owner() [1/2]

Object * ts::OwnedObject::owner ( )

inlineinherited

Get the address of the optional "owner" object which was specified in the constructor.

Returns: Address of the "owner" object or a null pointer if there was none.

◆ owner() [2/2]

template<class OBJECT >
requires std::derived_from<OBJECT, ts::Object>

OBJECT * ts::OwnedObject::owner ( )

inherited

Get the address of the "owner" object which was specified in the constructor.

This template version requires that the owner objet is set and of type OBJECT, or some subclass of it. If there is no owner object or if it is not compatible with the template class OBJECT, this is a fatal error and the application is terminated.

Template Parameters

OBJECT A subclass of Object

Returns: Address of the "owner" object or a null pointer if there was none.

◆ isOwned() [1/2]

bool ts::OwnedObject::isOwned ( )

inlineinherited

Check if the object is owned.

Returns: True if this object has an owner, false otherwise.

◆ isOwned() [2/2]

template<class OBJECT >
requires std::derived_from<OBJECT, ts::Object>

bool ts::OwnedObject::isOwned ( )

inlineinherited

Check if the object is owned by an object of a given type.

Template Parameters

OBJECT A subclass of Object

Returns: True if this object has an owner by an object of type OBJECT, false otherwise.

◆ handleTimer()

virtual void ts::ReactorHandlerInterface::handleTimer	(	Reactor &	reactor,
		EventId	id
	)

virtualinherited

Handle a timer in a Reactor.

Parameters

[in,out]	reactor	Reactor into which the handler is invoked.
[in]	id	Id of the timer which expires.

◆ handleBroadcastEvent()

virtual void ts::ReactorHandlerInterface::handleBroadcastEvent	(	Reactor &	reactor,
		int	error_code,
		const ObjectPtr &	user_data
	)

virtualinherited

Handle a broadcast event in a Reactor.

A broadcast event is sent to all currently registered events in the reactor.

Parameters

[in,out]	reactor	Reactor into which the handler is invoked.
[in]	error_code	Application-specific error code which was passed to Reactor::signalBroadcastEvent().
[in]	user_data	The user-data shared pointer which was passed to Reactor::signalBroadcastEvent().

◆ handleReadReady()

virtual void ts::ReactorHandlerInterface::handleReadReady	(	Reactor &	reactor,
		EventId	id,
		int	error_code
	)

virtualinherited

Handle a read-ready event in a Reactor.

This handler is only invoked in the non-blocking I/O model.

Parameters

[in,out]	reactor	Reactor into which the handler is invoked.
[in]	id	Id of the event which was signaled.
[in]	error_code	System-specific error code, zero on success, SYS_ERROR in case of unknown error.

Reimplemented in ts::ReactiveTCPConnection.

◆ handleWriteReady()

virtual void ts::ReactorHandlerInterface::handleWriteReady	(	Reactor &	reactor,
		EventId	id,
		int	error_code
	)

virtualinherited

Handle a write-ready event in a Reactor.

This handler is only invoked in the non-blocking I/O model.

Parameters

[in,out]	reactor	Reactor into which the handler is invoked.
[in]	id	Id of the event which was signaled.
[in]	error_code	System-specific error code, zero on success, SYS_ERROR in case of unknown error.

Reimplemented in ts::ReactiveTCPConnection.

◆ handleAsynchronousIO()

virtual void ts::ReactorHandlerInterface::handleAsynchronousIO	(	Reactor &	reactor,
		EventId	id,
		NonBlockingDevice::IOSB &	iosb,
		size_t	io_size
	)

virtualinherited

Handle an asynchronous I/O completion event in a Reactor.

This handler is only invoked in the asynchronous I/O model.

Parameters

[in,out]	reactor	Reactor into which the handler is invoked.
[in]	id	Id of the event which was signaled.
[in,out]	iosb	IOSB structure which was used when the asynchronous I/O was started. A system-specific error code is in iosb, SYS_CANCELED if the I/O was canceled before completion.
[in]	io_size	Size of the I/O in bytes.

Reimplemented in ts::ReactiveTCPConnection.

The documentation for this class was generated from the following file:

tsReactiveWorkerPool.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ReactiveWorkerPool()

Member Function Documentation

◆ setMaxThreads()

◆ maxThreads()

◆ currentThreads()

◆ currentBusyThreads()

◆ setStackSize()

◆ startWork()

◆ waitForTermination()

◆ processQueuedOperations()

◆ reactor()

◆ signalQueuedOperations()

◆ deactivateQueuedOperations()

◆ createSignalQueuedOperations()

◆ uncheckedSignalQueuedOperations()

◆ handleUserEvent()

◆ report()

◆ setReport() [1/2]

◆ setReport() [2/2]

◆ muteReport()

◆ SilentLevel()

◆ owner() [1/2]

◆ owner() [2/2]

◆ isOwned() [1/2]

◆ isOwned() [2/2]

◆ handleTimer()

◆ handleBroadcastEvent()

◆ handleReadReady()

◆ handleWriteReady()

◆ handleAsynchronousIO()