--- name: "ACE_Thread" section: "3" platform: "linux" package: "libace-doc" version: "5.0.7-4" release: "Debian 2.2 (Potato)" platforms: ["linux"] url: "https://new.carta.tech/ACE_Thread" --- # ACE\_Thread(3) Provides a wrapper for threads. ## NAME ACE\_Thread - Provides a wrapper for threads. ## SYNOPSIS ``` #include class ACE_Thread { public: 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 = 0, ACE_Thread_Adapter *thread_adapter = 0 ); static int 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 int 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 int join (ACE_thread_t, ACE_thread_t *, void **status = 0); static int join (ACE_hthread_t, void ** = 0); static int resume (ACE_hthread_t); static int suspend (ACE_hthread_t); static int getprio (ACE_hthread_t, int &prio); static int setprio (ACE_hthread_t, int prio); static int kill (ACE_thread_t, int signum); static void yield (void); static void self (ACE_hthread_t &t_handle); static ACE_thread_t self (void); static void exit (void *status = 0); static int getconcurrency (void); static int setconcurrency (int new_level); static int sigsetmask ( int how, const sigset_t *sigset, sigset_t *osigset = 0 ); static int keycreate ( ACE_thread_key_t *keyp, ACE_THR_C_DEST destructor, ACE_THR_DEST destructor, void * = 0 ); static int keyfree (ACE_thread_key_t key); 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); static int enablecancel ( struct cancel_state *old_state, int flag ); static int setcancelstate ( struct cancel_state &new_state, struct cancel_state *old_state ); static int cancel (ACE_thread_t t_id); static void testcancel (void); private: ACE_Thread (void); }; ``` ## DESCRIPTION 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 ACE\_Thread API since the thread manager is more powerful. ## PUBLIC MEMBERS ``` 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 = 0, ACE_Thread_Adapter *thread_adapter = 0 ); ``` 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: 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 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 EXTREMEMLY implementation-dependent, and are probably best avoided. Note that thread\_adapter is always deleted by thr\_create, therefore it must be allocated with global operator new. ``` static int 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 ); ``` 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. ``` static int 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 ); ``` 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. ``` static int join (ACE_thread_t, ACE_thread_t *, void **status = 0); ``` Wait for one or more threads to exit. ``` static int join (ACE_hthread_t, void ** = 0); ``` Wait for one thread to exit. ``` 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, int &prio); ``` Get the priority of a particular thread. ``` static int setprio (ACE_hthread_t, int prio); ``` Set the priority of a particular thread. ``` static int kill (ACE_thread_t, int signum); ``` Send a signal to the thread. ``` static void yield (void); ``` Yield the thread to another. ``` static void self (ACE_hthread_t &t_handle); ``` 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. ``` static ACE_thread_t self (void); ``` Return the unique ID of the thread. ``` static void exit (void *status = 0); ``` Exit the current thread and return "status". Should \_not\_ be called by main thread. ``` static int getconcurrency (void); ``` 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_C_DEST destructor, ACE_THR_DEST destructor, void * = 0 ); ``` 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. ``` 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); ``` Bind value to the thread-specific data key, key, for the calling thread. ``` static int getspecific (ACE_thread_key_t key, void **valuep); ``` Stores the current value bound to key for the calling thread into the location pointed to by 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); ``` Cancel a thread. ``` static void testcancel (void); ``` Test the cancel. ## PRIVATE MEMBERS ``` ACE_Thread (void); ``` Ensure that we don't get instantiated. ## AUTHOR Doug Schmidt ## LIBRARY ace