ucommon::Thread Class Reference

An abstract class for defining classes that operate as a thread. More...

#include <thread.h>

Inheritance diagram for ucommon::Thread:
Inheritance graph
[legend]

Public Member Functions

virtual void exit (void)
 Exit the thread context.
bool isRunning (void)
 operator bool ()
bool operator! ()
virtual void run (void)=0
 Abstract interface for thread context run method.
void setPriority (void)
 Set thread priority without disrupting scheduling if possible.
virtual ~Thread ()
 Destroy thread object, thread-specific data, and execution context.

Static Public Member Functions

static void concurrency (int level)
 Set concurrency level of process.
static bool equal (pthread_t thread1, pthread_t thread2)
 Determine if two thread identifiers refer to the same thread.
static Threadget (void)
 Get mapped thread object.
static void init (void)
 Used to initialize threading library.
static void policy (int polid)
 Used to specify scheduling policy for threads above priority "0".
static pthread_t self (void)
 Get current thread id.
static void sleep (timeout_t timeout)
 Sleep current thread for a specified time period.
static void yield (void)
 Yield execution context of the current thread.

Protected Types

enum  

Protected Member Functions

virtual bool is_active (void)
 Check if running.
void map (void)
 Map thread for get method.
 Thread (size_t stack=0)
 Create a thread object that will have a preset stack size.

Protected Attributes

void * cancellor
int priority
enum ucommon::Thread:: { ... }  reserved
size_t stack
pthread_t tid

Detailed Description

An abstract class for defining classes that operate as a thread.

A derived thread class has a run method that is invoked with the newly created thread context, and can use the derived object to store all member data that needs to be associated with that context. This means the derived object can safely hold thread-specific data that is managed with the life of the object, rather than having to use the clumsy thread-specific data management and access functions found in thread support libraries.

Author:
David Sugar <dyfet@gnutelephony.org>

Definition at line 1238 of file thread.h.


Constructor & Destructor Documentation

ucommon::Thread::Thread ( size_t  stack = 0  )  [protected]

Create a thread object that will have a preset stack size.

If 0 is used, then the stack size is os defined/default.

Parameters:
stack size to use or 0 for default.

Member Function Documentation

static void ucommon::Thread::concurrency ( int  level  )  [static]

Set concurrency level of process.

This is essentially a portable wrapper for pthread_setconcurrency.

static bool ucommon::Thread::equal ( pthread_t  thread1,
pthread_t  thread2 
) [static]

Determine if two thread identifiers refer to the same thread.

Parameters:
thread1 to test.
thread2 to test.
Returns:
true if both are the same context.
virtual void ucommon::Thread::exit ( void   )  [virtual]

Exit the thread context.

This function should NO LONGER be called directly to exit a running thread. Instead this method will only be used to modify the behavior of the thread context at thread exit, including detached threads which by default delete themselves. This documented usage was changed to support Mozilla NSPR exit behavior in case we support NSPR as an alternate thread runtime in the future.

Reimplemented in ucommon::DetachedThread.

static Thread* ucommon::Thread::get ( void   )  [static]

Get mapped thread object.

This returns the mapped base class of the thread object of the current executing context. You will need to cast to the correct derived class to access derived thread-specific storage. If the current thread context is not mapped NULL is returned.

static void ucommon::Thread::init ( void   )  [static]

Used to initialize threading library.

May be needed for some platforms.

void ucommon::Thread::map ( void   )  [protected]

Map thread for get method.

This should be called from start of the run() method of a derived class.

static void ucommon::Thread::policy ( int  polid  )  [static]

Used to specify scheduling policy for threads above priority "0".

Normally we apply static realtime policy SCHED_FIFO (default) or SCHED_RR. However, we could apply SCHED_OTHER, etc.

static pthread_t ucommon::Thread::self ( void   )  [static]

Get current thread id.

Returns:
thread id.
void ucommon::Thread::setPriority ( void   ) 

Set thread priority without disrupting scheduling if possible.

Based on scheduling policy. It is recommended that the process is set for realtime scheduling, and this method is actually for internal use.

static void ucommon::Thread::sleep ( timeout_t  timeout  )  [static]

Sleep current thread for a specified time period.

Parameters:
timeout to sleep for in milliseconds.
static void ucommon::Thread::yield ( void   )  [static]

Yield execution context of the current thread.

This is a static and may be used anywhere.


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

Generated on 30 Jul 2013 for UCommon by  doxygen 1.6.1