ACE_Thread Class Reference

Provides a wrapper for threads. More...

#include <Thread.h>

List of all members.

Static Public Member Functions
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)
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)
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)
int	join (ACE_thread_t thread_id, ACE_thread_t *departed, ACE_THR_FUNC_RETURN *status)
int	join (ACE_hthread_t, ACE_THR_FUNC_RETURN *=0)
	Wait for one thread to exit and reap its exit status.
int	resume (ACE_hthread_t)
	Continue the execution of a previously suspended thread.
int	suspend (ACE_hthread_t)
	Suspend the execution of a particular thread.
int	getprio (ACE_hthread_t ht_id, int &priority)
	Get the priority of a particular thread.
int	getprio (ACE_hthread_t ht_id, int &priority, int &policy)
	Get the priority and policy of a particular thread.
int	setprio (ACE_hthread_t ht_id, int priority, int policy=-1)
	Set the priority of a particular thread.
int	kill (ACE_thread_t, int signum)
	Send a signal to the thread.
void	yield (void)
	Yield the thread to another.
void	self (ACE_hthread_t &t_handle)
ACE_thread_t	self (void)
	Return the unique ID of the thread.
void	exit (ACE_THR_FUNC_RETURN status=0)
int	getconcurrency (void)
	Get the LWP concurrency level of the process.
int	setconcurrency (int new_level)
	Set the LWP concurrency level of the process.
int	sigsetmask (int how, const sigset_t *sigset, sigset_t *osigset=0)
	Change and/or examine calling thread's signal mask.
int	keycreate (ACE_thread_key_t *keyp, ACE_THR_DEST destructor, void *=0)
int	keyfree (ACE_thread_key_t key)
	Free up the key so that other threads can reuse it.
int	setspecific (ACE_thread_key_t key, void *value)
int	getspecific (ACE_thread_key_t key, void **valuep)
int	disablecancel (struct cancel_state *old_state)
	Disable thread cancellation.
int	enablecancel (struct cancel_state *old_state, int flag)
	Enable thread cancellation.
int	setcancelstate (struct cancel_state &new_state, struct cancel_state *old_state)
	Set the cancellation state.
int	cancel (ACE_thread_t t_id)
void	testcancel (void)
	Test the cancel.
Private Member Functions
	ACE_Thread (void)
	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, Solaris threads, 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 API since the thread manager is more powerful.

Definition at line 51 of file Thread.h.

---

Constructor & Destructor Documentation

ACE_Thread::ACE_Thread (  void   )  [private]

Ensure that we don't get instantiated.

---

Member Function Documentation

ACE_INLINE int ACE_Thread::cancel (  ACE_thread_t  t_id  )  [static]

Cancel a thread. Note: This method is only portable on platforms, such as POSIX pthreads, that support thread cancellation. Definition at line 241 of file Thread.inl. References ACE_TRACE, and ACE_OS::thr_cancel(). Referenced by ACE_Thread_Manager::cancel_thr(). { ACE_TRACE ("ACE_Thread::cancel"); return ACE_OS::thr_cancel (t_id); }

ACE_INLINE int ACE_Thread::disablecancel (  struct cancel_state *  old_state  )  [static]

Disable thread cancellation. Definition at line 162 of file Thread.inl. References ACE_TRACE, ACE_OS::memset(), and ACE_OS::thr_setcancelstate(). { ACE_TRACE ("ACE_Thread::disablecancel"); int old_cstate = 0; int result = ACE_OS::thr_setcancelstate (THR_CANCEL_DISABLE, &old_cstate); if (result == 0 && old_state != 0) { ACE_OS::memset (old_state, 0, sizeof (old_state)); old_state->cancelstate = old_cstate; } return result; }

ACE_INLINE int ACE_Thread::enablecancel (  struct cancel_state *  old_state, int  flag )  [static]

Enable thread cancellation. Definition at line 180 of file Thread.inl. References ACE_TRACE, cancel_state::cancelstate, cancel_state::canceltype, ACE_OS::thr_setcancelstate(), and ACE_OS::thr_setcanceltype(). { ACE_TRACE ("ACE_Thread::enablecancel"); int old_cstate = 0; int old_ctype = 0; int result; result = ACE_OS::thr_setcancelstate (THR_CANCEL_ENABLE, &old_cstate); if (result != 0) return result; result = ACE_OS::thr_setcanceltype (flag, &old_ctype); if (result != 0) return result; if (old_state != 0) { old_state->cancelstate = old_cstate; old_state->canceltype = old_ctype; } return 0; }

ACE_INLINE void ACE_Thread::exit (  ACE_THR_FUNC_RETURN  status = 0  )  [static]

Exit the current thread and return "status". Should _not_ be called by main thread. Definition at line 63 of file Thread.inl. References ACE_TRACE, and ACE_OS::thr_exit(). Referenced by ACE_Thread_Manager::exit(). { ACE_TRACE ("ACE_Thread::exit"); ACE_OS::thr_exit (status); }

ACE_INLINE int ACE_Thread::getconcurrency (  void   )  [static]

Get the LWP concurrency level of the process. Definition at line 139 of file Thread.inl. References ACE_TRACE, and ACE_OS::thr_getconcurrency(). { ACE_TRACE ("ACE_Thread::getconcurrency"); return ACE_OS::thr_getconcurrency (); }

ACE_INLINE int ACE_Thread::getprio (  ACE_hthread_t  ht_id, int &  priority, int &  policy )  [static]

Get the priority and policy of a particular thread. Definition at line 271 of file Thread.inl. References ACE_hthread_t, ACE_TRACE, and ACE_OS::thr_getprio(). { ACE_TRACE ("ACE_Thread::getprio"); return ACE_OS::thr_getprio (ht_id, priority, policy); }

ACE_INLINE int ACE_Thread::getprio (  ACE_hthread_t  ht_id, int &  priority )  [static]

Get the priority of a particular thread. Definition at line 264 of file Thread.inl. References ACE_hthread_t, ACE_TRACE, and ACE_OS::thr_getprio(). { ACE_TRACE ("ACE_Thread::getprio"); return ACE_OS::thr_getprio (ht_id, priority); }

ACE_INLINE int ACE_Thread::getspecific (  ACE_thread_key_t  key, void **  valuep )  [static]

Stores the current value bound to key for the calling thread into the location pointed to by valuep. Definition at line 49 of file Thread.inl. References ACE_thread_key_t, and ACE_OS::thr_getspecific(). Referenced by ACE_Log_Msg::close(), ACE_Log_Msg::exists(), and ACE_Log_Msg::instance(). { // ACE_TRACE ("ACE_Thread::getspecific"); return ACE_OS::thr_getspecific (key, valuep); }

ACE_INLINE int ACE_Thread::join (  ACE_hthread_t  , ACE_THR_FUNC_RETURN *  = 0 )  [static]

Wait for one thread to exit and reap its exit status. Definition at line 131 of file Thread.inl. References ACE_hthread_t, ACE_TRACE, and ACE_OS::thr_join(). { ACE_TRACE ("ACE_Thread::join"); return ACE_OS::thr_join (wait_for, status); }

ACE_INLINE int ACE_Thread::join (  ACE_thread_t  thread_id, ACE_thread_t *  departed, ACE_THR_FUNC_RETURN *  status )  [static]

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 (for example, Solaris). 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. Definition at line 122 of file Thread.inl. References ACE_TRACE, and ACE_OS::thr_join(). Referenced by ACE_Thread_Manager::join(), ACE_Thread_Manager::join_thr(), ACE_Thread_Manager::wait(), ACE_Thread_Manager::wait_grp(), and ACE_Thread_Manager::wait_task(). { ACE_TRACE ("ACE_Thread::join"); return ACE_OS::thr_join (wait_for, departed, status); }

ACE_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE int ACE_Thread::keycreate (  ACE_thread_key_t *  keyp, ACE_THR_DEST  destructor, void *  = 0 )  [static]

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. Definition at line 14 of file Thread.inl. References ACE_thread_key_t, and ACE_OS::thr_keycreate(). Referenced by ACE_Log_Msg::instance(). { // ACE_TRACE ("ACE_Thread::keycreate"); return ACE_OS::thr_keycreate (keyp, destructor, inst); }

ACE_INLINE int ACE_Thread::keyfree (  ACE_thread_key_t  key  )  [static]

Free up the key so that other threads can reuse it. Definition at line 29 of file Thread.inl. References ACE_thread_key_t, ACE_TRACE, and ACE_OS::thr_keyfree(). { ACE_TRACE ("ACE_Thread::keyfree"); return ACE_OS::thr_keyfree (key); }

ACE_INLINE int ACE_Thread::kill (  ACE_thread_t  , int  signum )  [static]

Send a signal to the thread. Definition at line 115 of file Thread.inl. References ACE_TRACE, and ACE_OS::thr_kill(). Referenced by ACE_Thread_Manager::kill_thr(). { ACE_TRACE ("ACE_Thread::kill"); return ACE_OS::thr_kill (t_id, signum); }

ACE_INLINE int ACE_Thread::resume (  ACE_hthread_t   )  [static]

Continue the execution of a previously suspended thread. Definition at line 101 of file Thread.inl. References ACE_hthread_t, ACE_TRACE, and ACE_OS::thr_continue(). Referenced by ACE_Thread_Manager::resume_thr(). { ACE_TRACE ("ACE_Thread::resume"); return ACE_OS::thr_continue (t_id); }

ACE_INLINE ACE_thread_t ACE_Thread::self (  void   )  [static]

Return the unique ID of the thread. Definition at line 56 of file Thread.inl. References ACE_OS::thr_self(). Referenced by ACE_Task_Base::cleanup(), ACE_Log_Msg::log(), ACE_Select_Reactor_T< ACE_SELECT_REACTOR_TOKEN >::open(), ACE_TP_Reactor::owner(), ACE_Token::renew(), ACE_Token::shared_acquire(), ACE_Thread_Timer_Queue_Adapter< TQ >::svc(), and ACE_Thread_Manager::thr_self(). { // ACE_TRACE ("ACE_Thread::self"); return ACE_OS::thr_self (); }

ACE_INLINE void ACE_Thread::self (  ACE_hthread_t &  t_handle  )  [static]

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. Definition at line 257 of file Thread.inl. References ACE_hthread_t, and ACE_OS::thr_self(). { // ACE_TRACE ("ACE_Thread::self"); ACE_OS::thr_self (t_id); }

ACE_INLINE int ACE_Thread::setcancelstate (  struct cancel_state &  new_state, struct cancel_state *  old_state )  [static]

Set the cancellation state. Definition at line 208 of file Thread.inl. References ACE_TRACE, cancel_state::cancelstate, cancel_state::canceltype, ACE_OS::thr_setcancelstate(), and ACE_OS::thr_setcanceltype(). { ACE_TRACE ("ACE_Thread::setcancelstate"); int old_cstate = 0; int old_ctype = 0; if (new_state.cancelstate != 0 && ACE_OS::thr_setcancelstate (new_state.cancelstate, &old_cstate) != 0) return -1; if (new_state.canceltype != 0 && ACE_OS::thr_setcanceltype (new_state.canceltype, &old_ctype) != 0) { int o_cstate; ACE_OS::thr_setcancelstate (old_cstate, &o_cstate); return -1; } if (old_state != 0) { old_state->cancelstate = old_cstate; old_state->canceltype = old_ctype; } return 0; }

ACE_INLINE int ACE_Thread::setconcurrency (  int  new_level  )  [static]

Set the LWP concurrency level of the process. Definition at line 146 of file Thread.inl. References ACE_TRACE, and ACE_OS::thr_setconcurrency(). { ACE_TRACE ("ACE_Thread::setconcurrency"); return ACE_OS::thr_setconcurrency (new_level); }

ACE_INLINE int ACE_Thread::setprio (  ACE_hthread_t  ht_id, int  priority, int  policy = -1 )  [static]

Set the priority of a particular thread. Definition at line 278 of file Thread.inl. References ACE_hthread_t, ACE_TRACE, and ACE_OS::thr_setprio(). { ACE_TRACE ("ACE_Thread::setprio"); return ACE_OS::thr_setprio (ht_id, priority, policy); }

ACE_INLINE int ACE_Thread::setspecific (  ACE_thread_key_t  key, void *  value )  [static]

Bind value to the thread-specific data key, key, for the calling thread. Definition at line 39 of file Thread.inl. References ACE_thread_key_t, and ACE_OS::thr_setspecific(). Referenced by ACE_Log_Msg::close(), and ACE_Log_Msg::instance(). { // ACE_TRACE ("ACE_Thread::setspecific"); return ACE_OS::thr_setspecific (key, value); }

ACE_INLINE int ACE_Thread::sigsetmask (  int  how, const sigset_t *  sigset, sigset_t *  osigset = 0 )  [static]

Change and/or examine calling thread's signal mask. Definition at line 153 of file Thread.inl. References ACE_TRACE, and ACE_OS::thr_sigsetmask(). { ACE_TRACE ("ACE_Thread::sigsetmask"); return ACE_OS::thr_sigsetmask (how, sigset, osigset); }

ACE_INLINE 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 )  [static]

Creates a new thread having attributes and running with (if is non-0 then and are ignored and are obtained from ). and are set to the thread's ID and handle (?), respectively. The thread runs at priority (see below). The 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 is set to ACE_DEFAULT_THREAD_PRIORITY, an "appropriate" priority value for the given scheduling policy (specified in <flags}>, e.g., ) 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 EXTREMEMLY implementation-dependent, and are probably best avoided. Note that is always deleted when is called, so it must be allocated with global operator new. Definition at line 77 of file Thread.inl. References ACE_hthread_t, ACE_TRACE, and ACE_OS::thr_create(). Referenced by ACE_Thread_Manager::spawn_i(). { ACE_TRACE ("ACE_Thread::spawn"); return ACE_OS::thr_create (func, arg, flags, t_id, t_handle, priority, thr_stack, thr_stack_size, thread_adapter); }

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 )  [static]

Spawn n new threads, which execute with argument (if is non-0 then and are ignored and are obtained from ). The thread_ids of successfully spawned threads will be placed into the buffer (which must be the same size as n). If != 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 != 0 it is assumed to be an array of n values indicating how big each of the corresponding s are. If != 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() Definition at line 48 of file Thread.cpp. References ACE_DEFAULT_THREAD_STACKSIZE, ACE_hthread_t, ACE_thread_t, ACE_TRACE, and ACE_OS::thr_create(). { ACE_TRACE ("ACE_Thread::spawn_n"); size_t i; for (i = 0; i < n; i++) { ACE_thread_t t_id; ACE_hthread_t t_handle; int result = ACE_OS::thr_create (func, arg, flags, &t_id, &t_handle, priority, stack == 0 ? 0 : stack[i], stack_size == 0 ? ACE_DEFAULT_THREAD_STACKSIZE : stack_size[i], thread_adapter); if (result == 0) { if (thread_ids != 0) thread_ids[i] = t_id; if (thread_handles != 0) thread_handles[i] = t_handle; } else // Bail out if error occurs. break; } return i; }

ACE_BEGIN_VERSIONED_NAMESPACE_DECL 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 )  [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 s 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() Definition at line 18 of file Thread.cpp. References ACE_DEFAULT_THREAD_STACKSIZE, ACE_thread_t, ACE_TRACE, and ACE_OS::thr_create(). { ACE_TRACE ("ACE_Thread::spawn_n"); ACE_thread_t t_id; size_t i; for (i = 0; i < n; i++) // Bail out if error occurs. if (ACE_OS::thr_create (func, arg, flags, &t_id, 0, priority, stack == 0 ? 0 : stack[i], stack_size == 0 ? ACE_DEFAULT_THREAD_STACKSIZE : stack_size[i], thread_adapter) != 0) break; return i; }

ACE_INLINE int ACE_Thread::suspend (  ACE_hthread_t   )  [static]

Suspend the execution of a particular thread. Definition at line 108 of file Thread.inl. References ACE_hthread_t, ACE_TRACE, and ACE_OS::thr_suspend(). Referenced by ACE_Thread_Manager::suspend_thr(). { ACE_TRACE ("ACE_Thread::suspend"); return ACE_OS::thr_suspend (t_id); }

ACE_INLINE void ACE_Thread::testcancel (  void   )  [static]

Test the cancel. Definition at line 249 of file Thread.inl. References ACE_TRACE, and ACE_OS::thr_testcancel(). { ACE_TRACE ("ACE_Thread::testcancel"); ACE_OS::thr_testcancel (); }

ACE_INLINE void ACE_Thread::yield (  void   )  [static]

Yield the thread to another. Definition at line 70 of file Thread.inl. References ACE_TRACE, and ACE_OS::thr_yield(). { ACE_TRACE ("ACE_Thread::yield"); ACE_OS::thr_yield (); }

---

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

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

---