#include <Thread.h>

Inheritance diagram for icl_core::thread::Thread:

Public Member Functions
void	cancel ()
bool	checkHardRealtime ()
bool	execute () const
bool	executesHardRealtime () const
icl_core::String	getDescription () const
bool	isHardRealtime () const
void	join ()
virtual void	onStop ()
icl_core::ThreadPriority	priority () const
virtual void	run ()=0
bool	running () const
void	setDescription (const icl_core::String &description)
bool	setHardRealtime (bool hard_realtime=true)
bool	setPriority (icl_core::ThreadPriority priority)
bool	start ()
void	stop ()
	Thread (const icl_core::String &description, icl_core::ThreadPriority priority=0)
icl_core::ThreadId	threadId () const
const char *	threadInfo () const
bool	threadSelf () const
bool	wait ()
bool	wait (const icl_core::TimeStamp &timeout)
bool	wait (const icl_core::TimeSpan &timeout)
virtual	~Thread ()
Static Public Member Functions
static icl_core::ThreadId	selfId ()
Private Member Functions
virtual void	makePeriodic ()
void	runThread ()
void	waitStarted () const
Private Attributes
bool	m_execute
bool	m_finished
ThreadImpl *	m_impl
bool	m_joined
icl_core::ThreadPriority	m_priority
bool	m_starting
icl_core::String	m_thread_info
Mutex	m_thread_mutex
Friends
class	ThreadImplLxrt33
class	ThreadImplLxrt35
class	ThreadImplLxrt38
class	ThreadImplPosix
class	ThreadImplWin32

Detailed Description

Only for base functionality. You may use functions of this class, but never create one. Use template class TThreadContainer instead.

For developers: The ThreadImpl class must implement the following functions:

bool StartImpl(): return true if a thread was succesfully created
void CancelImpl(): terminates the thread
bool ThreadSelfImpl(): return true if calling thread is this thread
ThreadId ThreadIdImpl(): returns the thread ID of this thread
static ThreadId SelfIdImpl(): returns the thread id of the calling thread
bool IsHardRealtimeImpl(): returns true if the thread is still in HRT mode
bool IsHardRealtimeThreadImpl(): returns true is the thread is supposed to be HRT
void SleepImpl(TimeSpan wait): suspend calling thread for the wait timespan (internally used)
int JoinImpl(): waits until the thread has finished.
int PriorityImpl(): returns the priority of this thread.
bool SetRealtimeModeImpl(bool hard): sets this thread to be a HRT thread. returns false, if the system does not support HRT

Definition at line 77 of file icl_core_thread/Thread.h.

Constructor & Destructor Documentation

icl_core::thread::Thread::Thread	(	const icl_core::String &	description,
		icl_core::ThreadPriority	priority = `0`
	)

Constructor. If the priority is negative and LXRT is available, the thread is processed in hard realtime.

Definition at line 49 of file icl_core_thread/Thread.cpp.

icl_core::thread::Thread::~Thread ( ) [virtual]

Deletes the thread. Stops it if it is still running.

Definition at line 83 of file icl_core_thread/Thread.cpp.

Member Function Documentation

void icl_core::thread::Thread::cancel ( )

Forces the thread to terminate. If this function is called the thread has no chance to cleanup resources or its current computation.

Use stop() in combination with wait() or join() to cooperatively terminate a thread.

Definition at line 95 of file icl_core_thread/Thread.cpp.

bool icl_core::thread::Thread::checkHardRealtime ( )

Checks whether the RT task is in hard or soft real time mode. Returns false, if the thread is in hard real time mode or is no hard real time thread at all.

If this function is called from inside the thread, it will be reset into hard real time mode if necessary.

Definition at line 109 of file icl_core_thread/Thread.cpp.

bool icl_core::thread::Thread::execute ( ) const [inline]

Call this from inside the thread code if you want to check whether the thread was demanded to stop from outside.

Returns:: false if the thread has been asked to stop, true otherwise.

Definition at line 117 of file icl_core_thread/Thread.h.

bool icl_core::thread::Thread::executesHardRealtime ( ) const

Returns true if this thread actually executes in hard realtime mode.

Definition at line 133 of file icl_core_thread/Thread.cpp.

icl_core::String icl_core::thread::Thread::getDescription ( ) const

Returns the thread's description.

Definition at line 123 of file icl_core_thread/Thread.cpp.

bool icl_core::thread::Thread::isHardRealtime ( ) const

Returns true if this is defined to be a hard realtime thread.

Definition at line 128 of file icl_core_thread/Thread.cpp.

void icl_core::thread::Thread::join ( )

Wait for the thread to finish. Returns immediately if the thread is not running.

Definition at line 138 of file icl_core_thread/Thread.cpp.

void icl_core::thread::Thread::makePeriodic ( ) [private, virtual]

Makes the thread periodic.

This function is overridden in PeriodicThread.

Reimplemented in icl_core::thread::PeriodicThread.

Definition at line 504 of file icl_core_thread/Thread.cpp.

virtual void icl_core::thread::Thread::onStop ( ) [inline, virtual]

This function is called from the Stop() function. Subclasses can implement this function, if they need to do special processing when the thread is stopped.

Definition at line 141 of file icl_core_thread/Thread.h.

icl_core::ThreadPriority icl_core::thread::Thread::priority ( ) const

Returns the thread's priority.

Definition at line 148 of file icl_core_thread/Thread.cpp.

virtual void icl_core::thread::Thread::run ( ) [pure virtual]

This is the function running in the thread. This has to be reimplemented from derived classes. If you start the thread by calling Start() this function is executed in the thread. If you call don't want that function to be executed in the thread you could call it directly in your derived class.

Implemented in BurnThread, PeriodicTestThread, icl_core::dispatch::PeriodicDispatchThread, icl_core::thread::ActiveObject, LoggingThread, MutexTestThread, RWLockTestThread, and TestThread.

bool icl_core::thread::Thread::running ( ) const [inline]

Returns:: true if the thread is currently running.

Definition at line 153 of file icl_core_thread/Thread.h.

void icl_core::thread::Thread::runThread ( ) [private]

Executes the thread. This function is intended to be called from thread implementations.

Definition at line 217 of file icl_core_thread/Thread.cpp.

static icl_core::ThreadId icl_core::thread::Thread::selfId ( ) [inline, static]

Returns the ID of the thread in which this function is called.

Definition at line 234 of file icl_core_thread/Thread.h.

void icl_core::thread::Thread::setDescription ( const icl_core::String & description )

Set the description of the thread.

Depending on the platform this description is either only kept within the icl_core implementation or - if supported - also handed over to the system.

Definition at line 153 of file icl_core_thread/Thread.cpp.

bool icl_core::thread::Thread::setHardRealtime ( bool hard_realtime = true )

Set this thread to hard or soft realtime mode.

Returns:: true if the thread could be set to the desired realtime mode, false otherwise.

Definition at line 158 of file icl_core_thread/Thread.cpp.

bool icl_core::thread::Thread::setPriority ( icl_core::ThreadPriority priority )

Changes the priority to the new specified value. Returns false if not successful. In the constructor of Thread the Priority is set to a sensible default value that depends on the underlying operation system.

Definition at line 163 of file icl_core_thread/Thread.cpp.

bool icl_core::thread::Thread::start ( )

Starts the thread.