This concrete class implements a Thread object using Posix threads. More...

Detailed Description

This concrete class implements a Thread object using Posix threads.

#include <Thread.h>

Inheritance diagram for Cpl::System::Posix::Thread:

Collaboration diagram for Cpl::System::Posix::Thread:

Public Member Functions
	Thread (Runnable &runnable, const char *name, int priority=CPL_SYSTEM_THREAD_PRIORITY_NORMAL, unsigned stackSize=0, int schedType=SCHED_OTHER, bool allowSimTicks=true)
	Constructor.

	~Thread ()
	Destructor.

const char *	getName () noexcept
	See Cpl::System::Thread.

size_t	getId () noexcept
	See Cpl::System::Thread.

bool	isRunning (void) noexcept
	See Cpl::System::Thread.

Cpl_System_Thread_NativeHdl_T	getNativeHandle (void) noexcept
	See Cpl::System::Thread.

Runnable &	getRunnable (void) noexcept
	See Cpl::System::Thread.

int	signal (void) noexcept
	See Cpl::System::Signable.

int	su_signal (void) noexcept
	See Cpl::System::Signable.

	Thread (Cpl::System::Runnable &dummyRunnable)
	Private constructor to convert the native Posix thread to a Cpl Thread.

Public Member Functions inherited from Cpl::System::Signable
virtual	~Signable ()
	Virtual destructor.

Public Member Functions inherited from Cpl::Container::Item
bool	insert_ (void *newContainerPtr)
	Helper method to trap when inserting an item in multiple containers.

bool	isInContainer_ (const void *containerPtr) const noexcept
	Returns 'true' if the instance is in the specified container.

Protected Attributes
Cpl::System::Runnable &	m_runnable
	Reference to the runnable object for the thread.

Cpl::Text::FString< 64 >	m_name
	ASCII name of the task.

size_t	m_threadID
	Thread ID.

bool	m_allowSimTicks
	Option to allow simulated ticks.

pthread_t	m_threadHandle
	internal handle

Cpl::System::Semaphore	m_syncSema
	The thread synchronized message semaphore.

Friends
class	Cpl::System::Thread
	Housekeeping.

Additional Inherited Members
Static Public Member Functions inherited from Cpl::System::Thread
static Thread &	getCurrent () noexcept
	This method returns a reference to the currently executing thread.

static Thread *	tryGetCurrent () noexcept
	Special version of getCurrent().

static void	wait () noexcept
	This method causes the CURRENT thread to wait until its 'thread semaphore' is signal/set.

static bool	tryWait () noexcept
	This method is similar to Semaphore::tryWait(), except that it operates on the thread semaphore.

static bool	timedWait (unsigned long timeoutInMsec) noexcept
	Same as wait(), except the call will return after 'timeoutInMsec' has expired without the thread being signaled.

static const char *	myName () noexcept
	Returns the name for the current thread (i.e.

static size_t	myId () noexcept
	Returns the ID for the current thread (i.e.

static Runnable &	myRunnable () noexcept
	This method returns a reference to the current thread' runnable instance.

static void	traverse (Thread::Traverser &client) noexcept
	Internal Iterator that allows the Client to traverse the list active threads.

static Thread *	create (Runnable &runnable, const char name, int priority=CPL_SYSTEM_THREAD_PRIORITY_NORMAL, int stackSize=0, void stackPtr=0, bool allowSimTicks=true)
	This method creates a thread according to the specified parameters.

static void	destroy (Thread &threadToDestroy)
	This method is used to destroy a thread that was created by the Thread Factory.

Static Public Member Functions inherited from Cpl::Container::Item
static void	remove_ (Item *itemPtr) noexcept
	Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.

Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.

void *	m_inListPtr_
	Debug field.

Protected Member Functions inherited from Cpl::Container::Item
	Item ()
	Constructor.

	Item (const char *)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Constructor & Destructor Documentation

◆ Thread() [1/2]

Cpl::System::Posix::Thread::Thread	(	Runnable &	runnable,
		const char *	name,
		int	priority = `CPL_SYSTEM_THREAD_PRIORITY_NORMAL`,
		unsigned	stackSize = `0`,
		int	schedType = `SCHED_OTHER`,
		bool	allowSimTicks = `true`
	)

Constructor.

o POSIX does not define/require specific Priority values, however
  it does define that the priority range must be at 32 and the
  a higher numerical value has higher priority... So the priority
  values support ONLY a range of 32, with N+1 having a higher
  priority than N.  At run time, the HIGHEST/LOWEST bounds will be
  mapped the actual range defined by the functions:
       sched_get_priority_max(), sched_get_priority_min()

o The preferred schedType is SCHED_RR or SCHED_FIFO - BUT these
  type require superuser privileges to work.  All of us mere
  mortals must use SCHED_OTHER.  SCHED_OTHER is defined as
  "normal scheduling" - what ever that means.  The biggest problem
  with SCHED_OTHER is that only ONE priority is supported -->BUMMER!
  You can still pass different priority values with SCHED_OTHER -
  but they will have no effect. The priority values WILL work if
  SCHED_RR or SCHED_FIFO is specified.

o Does NOT support the application supplying the stack
  memory.