ACE_Thread Class Reference

Provides a wrapper for threads. More...

#include <Thread.h>

Static Public Member Functions
static int	spawn (ACE_THR_FUNC func, void *arg=0, long flags=THR_NEW_LWP|THR_JOINABLE, ACE_thread_t *t_id=0, ACE_hthread_t *t_handle=0, long priority=ACE_DEFAULT_THREAD_PRIORITY, void *stack=0, size_t stack_size=ACE_DEFAULT_THREAD_STACKSIZE, ACE_Thread_Adapter *thread_adapter=0, const char **thr_name=0)
static size_t	spawn_n (size_t n, ACE_THR_FUNC func, void *arg=0, long flags=THR_NEW_LWP|THR_JOINABLE, long priority=ACE_DEFAULT_THREAD_PRIORITY, void *stack[]=0, size_t stack_size[]=0, ACE_Thread_Adapter *thread_adapter=0, const char *thr_name[]=0)
static size_t	spawn_n (ACE_thread_t thread_ids[], size_t n, ACE_THR_FUNC func, void *arg, long flags, long priority=ACE_DEFAULT_THREAD_PRIORITY, void *stack[]=0, size_t stack_size[]=0, ACE_hthread_t thread_handles[]=0, ACE_Thread_Adapter *thread_adapter=0, const char *thr_name[]=0)
static int	join (ACE_thread_t thread_id, ACE_thread_t *departed, ACE_THR_FUNC_RETURN *status)
static int	join (ACE_hthread_t, ACE_THR_FUNC_RETURN *=0)
	Wait for one thread to exit and reap its exit status.
static int	resume (ACE_hthread_t)
	Continue the execution of a previously suspended thread.
static int	suspend (ACE_hthread_t)
	Suspend the execution of a particular thread.
static int	getprio (ACE_hthread_t ht_id, int &priority)
	Get the priority of a particular thread.
static int	getprio (ACE_hthread_t ht_id, int &priority, int &policy)
	Get the priority and policy of a particular thread.
static int	setprio (ACE_hthread_t ht_id, int priority, int policy=-1)
	Set the priority of a particular thread.
static int	kill (ACE_thread_t, int signum)
	Send a signal to the thread.
static void	yield ()
	Yield the thread to another.
static void	self (ACE_hthread_t &t_handle)
static ACE_thread_t	self ()
	Return the unique ID of the thread.
static void	exit (ACE_THR_FUNC_RETURN status=0)
static int	getconcurrency ()
	Get the LWP concurrency level of the process.
static int	setconcurrency (int new_level)
	Set the LWP concurrency level of the process.
static int	sigsetmask (int how, const sigset_t *sigset, sigset_t *osigset=0)
	Change and/or examine calling thread's signal mask.
static int	keycreate (ACE_thread_key_t *keyp, ACE_THR_DEST destructor)
static int	keyfree (ACE_thread_key_t key)
	Free up the key so that other threads can reuse it.
static int	setspecific (ACE_thread_key_t key, void *value)
static int	getspecific (ACE_thread_key_t key, void **valuep)
static int	disablecancel (struct cancel_state *old_state)
	Disable thread cancellation.
static int	enablecancel (struct cancel_state *old_state, int flag)
	Enable thread cancellation.
static int	setcancelstate (struct cancel_state &new_state, struct cancel_state *old_state)
	Set the cancellation state.
static int	cancel (ACE_thread_t t_id)
static void	testcancel ()
	Test the cancel.

Private Member Functions
	ACE_Thread ()
	Ensure that we don't get instantiated.

Detailed Description

Provides a wrapper for threads.

This class provides a common interface that is mapped onto POSIX Pthreads, Win32 threads, VxWorks threads, or pSoS threads. Note, however, that it is generally a better idea to use the ACE_Thread_Manager programming API rather than the <ACE_Thread> API since the thread manager is more powerful.

Constructor & Destructor Documentation

ACE_Thread()

ACE_Thread::ACE_Thread ( )

private

Ensure that we don't get instantiated.

Member Function Documentation

cancel()

int ACE_Thread::cancel ( ACE_thread_t t_id )

inlinestatic

Cancel a thread.

Note

This method is only portable on platforms, such as POSIX pthreads, that support thread cancellation.

disablecancel()

int ACE_Thread::disablecancel ( struct cancel_state * old_state )

inlinestatic

Disable thread cancellation.

enablecancel()

int ACE_Thread::enablecancel ( struct cancel_state * old_state, int flag )

inlinestatic

Enable thread cancellation.

exit()

void ACE_Thread::exit ( ACE_THR_FUNC_RETURN status = 0 )

inlinestatic

Exit the current thread and return "status". Should not be called by main thread.

getconcurrency()

int ACE_Thread::getconcurrency ( )

inlinestatic

Get the LWP concurrency level of the process.

getprio() [1/2]

int ACE_Thread::getprio ( ACE_hthread_t ht_id, int & priority )

inlinestatic

Get the priority of a particular thread.

getprio() [2/2]

int ACE_Thread::getprio ( ACE_hthread_t ht_id, int & priority, int & policy )

inlinestatic

Get the priority and policy of a particular thread.

getspecific()

int ACE_Thread::getspecific ( ACE_thread_key_t key, void ** valuep )

inlinestatic

Stores the current value bound to key for the calling thread into the location pointed to by valuep.

Stores the current value bound to key> for the calling thread into the location pointed to by valuep.

join() [1/2]

int ACE_Thread::join ( ACE_hthread_t wait_for, ACE_THR_FUNC_RETURN * status = 0 )

inlinestatic

Wait for one thread to exit and reap its exit status.

join() [2/2]

int ACE_Thread::join ( ACE_thread_t thread_id, ACE_thread_t * departed, ACE_THR_FUNC_RETURN * status )

inlinestatic

Wait for one or more threads to exit and reap their exit status. thr_join() returns successfully when the target thread terminates.

Parameters

thread_id	is the ACE_thread_t ID of the thread to wait for. If thread_id is 0, join() waits for any undetached thread in the process to terminate on platforms that support this capability
departed	points to a location that is set to the ID of the terminated thread if join() returns successfully. If departed is 0, it is ignored.
status	Points to the location that receives the joined thread's exit value. If status is 0, it is ignored.

Return values

0	for success
-1	(with errno set) for failure.

keycreate()

int ACE_Thread::keycreate ( ACE_thread_key_t * keyp, ACE_THR_DEST destructor )

inlinestatic

Allocates a keyp that is used to identify data that is specific to each thread in the process. The key is global to all threads in the process.

keyfree()

int ACE_Thread::keyfree ( ACE_thread_key_t key )

inlinestatic

Free up the key so that other threads can reuse it.

kill()

int ACE_Thread::kill ( ACE_thread_t t_id, int signum )

inlinestatic

Send a signal to the thread.

resume()

int ACE_Thread::resume ( ACE_hthread_t t_id )

inlinestatic

Continue the execution of a previously suspended thread.

self() [1/2]

ACE_thread_t ACE_Thread::self ( )

inlinestatic

Return the unique ID of the thread.

self() [2/2]

void ACE_Thread::self ( ACE_hthread_t & t_handle )

inlinestatic

Return the unique kernel handle of the thread. Note that on Win32 this is actually a pseudohandle, which cannot be shared with other processes or waited on by threads. To locate the real handle, please use the ACE_Thread_Manager::thr_self() method.

setcancelstate()

int ACE_Thread::setcancelstate ( struct cancel_state & new_state, struct cancel_state * old_state )

inlinestatic

Set the cancellation state.

setconcurrency()

int ACE_Thread::setconcurrency ( int new_level )

inlinestatic

Set the LWP concurrency level of the process.

setprio()

int ACE_Thread::setprio ( ACE_hthread_t ht_id, int priority, int policy = -1 )

inlinestatic

Set the priority of a particular thread.

setspecific()

int ACE_Thread::setspecific ( ACE_thread_key_t key, void * value )

inlinestatic

Bind value to the thread-specific data key, key, for the calling thread.

sigsetmask()

int ACE_Thread::sigsetmask ( int how, const sigset_t * sigset, sigset_t * osigset = 0 )

inlinestatic

Change and/or examine calling thread's signal mask.

spawn()

int ACE_Thread::spawn ( ACE_THR_FUNC func, void * arg = 0, long flags = THR_NEW_LWP | THR_JOINABLE, ACE_thread_t * t_id = 0, ACE_hthread_t * t_handle = 0, long priority = ACE_DEFAULT_THREAD_PRIORITY, void * stack = 0, size_t stack_size = ACE_DEFAULT_THREAD_STACKSIZE, ACE_Thread_Adapter * thread_adapter = 0, const char ** thr_name = 0 )

inlinestatic

Creates a new thread having flags attributes and running func with args (if thread_adapter is non-0 then func and args are ignored and are obtained from thread_adapter>. thr_id and t_handle are set to the thread's ID and handle (?), respectively. The thread runs at priority priority (see below).

The flags are a bitwise-OR of the following: = BEGIN<INDENT> THR_CANCEL_DISABLE, THR_CANCEL_ENABLE, THR_CANCEL_DEFERRED, THR_CANCEL_ASYNCHRONOUS, THR_BOUND, THR_NEW_LWP, THR_DETACHED, THR_SUSPENDED, THR_DAEMON, THR_JOINABLE, THR_SCHED_FIFO, THR_SCHED_RR, THR_SCHED_DEFAULT, THR_EXPLICIT_SCHED, THR_SCOPE_SYSTEM, THR_SCOPE_PROCESS = END<INDENT>

By default, or if priority is set to ACE_DEFAULT_THREAD_PRIORITY, an "appropriate" priority value for the given scheduling policy (specified in flags, e.g., THR_SCHED_DEFAULT is used. This value is calculated dynamically, and is the median value between the minimum and maximum priority values for the given policy. If an explicit value is given, it is used. Note that actual priority values are EXTREMELY implementation-dependent, and are probably best avoided.

Note that thread_adapter is always deleted when spawn is called, so it must be allocated with global operator new.

spawn_n() [1/2]

size_t ACE_Thread::spawn_n ( ACE_thread_t thread_ids[], size_t n, ACE_THR_FUNC func, void * arg, long flags, long priority = ACE_DEFAULT_THREAD_PRIORITY, void * stack[] = 0, size_t stack_size[] = 0, ACE_hthread_t thread_handles[] = 0, ACE_Thread_Adapter * thread_adapter = 0, const char * thr_name[] = 0 )

static

Spawn n new threads, which execute func with argument arg (if thread_adapter is non-0 then func and args are ignored and are obtained from thread_adapter). The thread_ids of successfully spawned threads will be placed into the thread_ids buffer (which must be the same size as n). If stack != 0 it is assumed to be an array of n pointers to the base of the stacks to use for the threads being spawned. If stack_size != 0 it is assumed to be an array of n values indicating how big each of the corresponding stacks are. If thread_handles != 0 it is assumed to be an array of n thread_handles that will be assigned the values of the thread handles being spawned. Returns the number of threads actually spawned (if this doesn't equal the number requested then something has gone wrong and errno will explain...).

See also

spawn()

spawn_n() [2/2]

size_t ACE_Thread::spawn_n ( size_t n, ACE_THR_FUNC func, void * arg = 0, long flags = THR_NEW_LWP | THR_JOINABLE, long priority = ACE_DEFAULT_THREAD_PRIORITY, void * stack[] = 0, size_t stack_size[] = 0, ACE_Thread_Adapter * thread_adapter = 0, const char * thr_name[] = 0 )

static

Spawn N new threads, which execute func with argument arg (if thread_adapter is non-0 then func and args are ignored and are obtained from thread_adapter). If stack != 0 it is assumed to be an array of n pointers to the base of the stacks to use for the threads being spawned. Likewise, if stack_size != 0 it is assumed to be an array of n values indicating how big each of the corresponding stacks are. Returns the number of threads actually spawned (if this doesn't equal the number requested then something has gone wrong and errno will explain...).

See also

spawn()

suspend()

int ACE_Thread::suspend ( ACE_hthread_t t_id )

inlinestatic

Suspend the execution of a particular thread.

testcancel()

void ACE_Thread::testcancel ( )

inlinestatic

Test the cancel.

yield()

void ACE_Thread::yield ( )

inlinestatic

Yield the thread to another.

---

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

• Thread.h
• Thread.cpp
• Thread.inl