This class implements one thread of this thread pool. More...

#include <ThreadPool.h>

Inheritance diagram for Ocean::ThreadPool::PoolThread:

Public Member Functions
	PoolThread (const std::string &name)
	Creates a new thread object.

	~PoolThread () override
	Destructs a thread object.

bool	isBusy () const
	Returns whether this thread is currently busy.

void	invoke (Function &&function)
	Sets the thread function.

Protected Member Functions
void	threadRun () override
	Thread run function.

Protected Member Functions inherited from Ocean::Thread
	Thread (const Thread &thread)=delete
	Disabled copy constructor.

void	createThread ()
	Creates the thread itself.

void	destroyThread ()
	Destroys the thread itself.

void	stopThreadExplicitly (const unsigned int timeout=5000u)
	Tries to stop the thread gracefully.

Thread &	operator= (const Thread &thread)=delete
	The disabled assign operator.

	Thread (const std::string &name=std::string())
	Creates a new thread object.

	Thread (const unsigned int randomNumberSeedValue, const std::string &name=std::string())
	Creates a new thread object.

virtual	~Thread ()
	Destructs a thread object.

bool	startThread ()
	Starts the thread.

void	stopThread ()
	Informs the thread to stop.

bool	terminateThread ()
	Terminates the thread.

bool	joinThread (const unsigned int timeout=(unsigned int)(-1))
	Waits until this thread has been stopped.

bool	shouldThreadStop () const
	Returns whether this thread should stop.

bool	isThreadInvokedToStart () const
	Returns whether this thread has been invoked to start immediately.

bool	isThreadActive () const
	Returns whether this thread is active.

Protected Attributes
Signal	signal_
	Internal signal handling the internal thread execution.

Function	function_
	The function that is invoked in this thread.

Lock	lock_
	Thread lock.

Additional Inherited Members
Protected Types inherited from Ocean::Thread
typedef std::pair< pthread_t, bool >	TimedJoinPair
	Definition of a pair holding a thread id and a boolean state.

enum	ThreadPriority { PRIORITY_IDLE , PRIORTY_BELOW_NORMAL , PRIORTY_NORMAL , PRIORTY_ABOVE_NORMAL , PRIORTY_HIGH , PRIORTY_REALTIME }
	Definition of different thread priority values. More...

Static Protected Member Functions inherited from Ocean::Thread
static void	sleep (unsigned int ms)
	Sleeps the calling thread for a given time.

static void	giveUp ()
	Gives up the remaining thread time.

static ThreadId	currentThreadId ()
	Returns the thread id of the current (calling) thread.

static ThreadPriority	threadPriority ()
	Returns the priority of the current thread.

static bool	setThreadPriority (const ThreadPriority priority)
	Sets the priority of the current thread.

template<typename TObject , typename TExpectedValue >
static bool	waitForValue (TObject &object, const TExpectedValue &expectedValue, const double timeout=-1.0)
	Waits until an object/variable has an expected value.

template<typename TObject , typename TExpectedValue >
static bool	waitForValue (TObject &object, const TExpectedValue &expectedValue, TemporaryScopedLock &temporaryScopedLock, const double timeout=-1.0)
	Waits until an object/variable has an expected value.

static int	pthread_timedjoin_np (pthread_t thread, void *retval, const struct timespec abstime)
	Implements a thread join function with timeout value.

Detailed Description

This class implements one thread of this thread pool.

Constructor & Destructor Documentation

◆ PoolThread()

Ocean::ThreadPool::PoolThread::PoolThread ( const std::string & name )

explicit

Creates a new thread object.

Parameters

name	The thread name

◆ ~PoolThread()

Ocean::ThreadPool::PoolThread::~PoolThread ( )

override

Destructs a thread object.

Member Function Documentation

◆ invoke()

void Ocean::ThreadPool::PoolThread::invoke ( Function && function )

Sets the thread function.

Parameters

function The thread function that will be invoked in this thread

◆ isBusy()

bool Ocean::ThreadPool::PoolThread::isBusy ( ) const

inline

Returns whether this thread is currently busy.

Returns: True, if so

◆ threadRun()

void Ocean::ThreadPool::PoolThread::threadRun ( )

overrideprotectedvirtual

Thread run function.

Implements Ocean::Thread.

Field Documentation

◆ function_

Function Ocean::ThreadPool::PoolThread::function_

protected

The function that is invoked in this thread.

◆ lock_

Lock Ocean::ThreadPool::PoolThread::lock_

mutableprotected

Thread lock.

◆ signal_

Signal Ocean::ThreadPool::PoolThread::signal_

protected

Internal signal handling the internal thread execution.

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

ThreadPool.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members