<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GNU CommonC++: thread.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="classes.html"><span>Classes</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul></div>
<h1>thread.h File Reference</h1>Synchronization and threading services. <a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="config_8h-source.html">cc++/config.h</a>></code><br>
<code>#include <ctime></code><br>
<code>#include <pthread.h></code><br>
<code>#include <time.h></code><br>
<code>#include <signal.h></code><br>
<code>#include <unistd.h></code><br>
<p>
<a href="thread_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Namespaces</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceost.html">ost</a></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mutex.html">ost::Mutex</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classost_1_1_mutex.html">Mutex</a> class is used to protect a section of code so that at any given time only a single thread can perform the protected operation.Mutex lock for protected access. <a href="classost_1_1_mutex.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mutex_lock.html">ost::MutexLock</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classost_1_1_mutex_lock.html">MutexLock</a> class is used to protect a section of code so that at any given time only a single thread can perform the protected operation.Mutex automatic locker for protected access. <a href="classost_1_1_mutex_lock.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_lock.html">ost::ThreadLock</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classost_1_1_thread_lock.html">ThreadLock</a> class impliments a thread rwlock for optimal reader performance on systems which have rwlock support, and reverts to a simple mutex for those that do not.Posix rwlock extension for protected access. <a href="classost_1_1_thread_lock.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_read_lock.html">ost::ReadLock</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classost_1_1_read_lock.html">ReadLock</a> class is used to protect a section of code through a <a class="el" href="classost_1_1_thread_lock.html">ThreadLock</a> for "read" access to the member function.Read mode automatic locker for protected access. <a href="classost_1_1_read_lock.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_write_lock.html">ost::WriteLock</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classost_1_1_write_lock.html">WriteLock</a> class is used to protect a section of code through a <a class="el" href="classost_1_1_thread_lock.html">ThreadLock</a> for "write" access to the member function.Read mode automatic locker for protected access. <a href="classost_1_1_write_lock.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mutex_counter.html">ost::MutexCounter</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classost_1_1_mutex.html">Mutex</a> <a class="el" href="classost_1_1_counter.html">Counter</a> is a counter variable which can safely be incremented or decremented by multiple <a class="el" href="namespaceost.html#1a3b6738f6f759fcb52b544a4787cbb2">threads.Thread</a> protected integer counter. <a href="classost_1_1_mutex_counter.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_atomic_counter.html">ost::AtomicCounter</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classost_1_1_atomic_counter.html">AtomicCounter</a> class offers thread-safe manipulation of an integer counter.atomic counter operation. <a href="classost_1_1_atomic_counter.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_conditional.html">ost::Conditional</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A conditional variable synchcronization object for one to one and one to many signal and control events between processes.conditional. <a href="classost_1_1_conditional.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_semaphore.html">ost::Semaphore</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A semaphore is generally used as a synchronization object between multiple threads or to protect a limited and finite resource such as a memory or thread pool.Semaphore counter for thread synchronization. <a href="classost_1_1_semaphore.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_semaphore_lock.html">ost::SemaphoreLock</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classost_1_1_semaphore_lock.html">SemaphoreLock</a> class is used to protect a section of code through a semaphore so that only x instances of the member function may execute concurrently.Semaphore automatic locker for protected access. <a href="classost_1_1_semaphore_lock.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_event.html">ost::Event</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classost_1_1_event.html">Event</a> class implements a feature originally found in the WIN32 API; event <a class="el" href="namespaceost.html#1a3b6738f6f759fcb52b544a4787cbb2">notification.Thread</a> synchornization on event notification. <a href="classost_1_1_event.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread.html">ost::Thread</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Every thread of execution in an application is created by instantiating an object of a class derived from the <a class="el" href="classost_1_1_thread.html">Thread</a> class.base class used to derive all threads of execution. <a href="classost_1_1_thread.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_cancellation.html">ost::Cancellation</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A class to automatically set the thread cancellation mode of a member function.Automatic cancellation mode setting. <a href="classost_1_1_cancellation.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html">ost::PosixThread</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_key.html">ost::ThreadKey</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This class allows the creation of a thread context unique "pointer" that can be set and retrieved and can be used to create thread specific data areas for implementing "thread safe" library routines.container for thread specific data storage. <a href="classost_1_1_thread_key.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_timer_port.html">ost::TimerPort</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Timer ports are used to provide synchronized timing events when managed under a "service thread" such as SocketService.synchronized millisecond timing for service threads. <a href="classost_1_1_timer_port.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_sys_time.html">ost::SysTime</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This class is used to access non-reentrant date and time functions in the standard C <a class="el" href="namespaceost.html#1a3b6738f6f759fcb52b544a4787cbb2">library.Thread</a> safe date and time functions. <a href="classost_1_1_sys_time.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#9fc514088fa3739a1300ce30ca6585d5">CCXX_POSIX</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#74f2d4c747bce0b8f7f7c1f48e651876">TIMEOUT_INF</a> ~((<a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a>) 0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#9d5589bc014dcec626ff198d5c9370cd">ENTER_CRITICAL</a> enterMutex();</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#f1b76aeceb2370c5fcedee46f9cd3d09">LEAVE_CRITICAL</a> leaveMutex();</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#61438c8055883ef92ffb09c68f70f049">ENTER_DEFERRED</a> setCancel(cancelDeferred);</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#c6e53238dd0519d7c7117b2b40d4312b">LEAVE_DEFERRED</a> setCancel(cancelImmediate);</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#5e09ab8cba99b274fd420bd76f39b205">psleep</a>(x) (sleep)(x)</td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef pthread_t </td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#3f0d0226a694bf1e508e1b1c758e6ae6">cctid_t</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceost.html#5dca865b107f598c88bd2106ea56c16e">ost::signo_t</a></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">timespec * </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceost.html#8fd139f80e945ac6d8cc53868cdacca6">ost::getTimeout</a> (struct timespec *spec, <a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceost.html#24c7774639b3768bdd45b65a296f6369">ost::wait</a> (<a class="el" href="namespaceost.html#5dca865b107f598c88bd2106ea56c16e">signo_t</a> signo)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceost.html#1a3b6738f6f759fcb52b544a4787cbb2">Thread</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceost.html#99c7f7d02b00922b0f5ee62fc3bb75fd">ost::getThread</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">tm * </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceost.html#2532506cb80f89403523d977ef6c2345">ost::localtime_r</a> (const time_t *t, struct tm *b)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceost.html#1951b0e03ecb3bf227e19855d3a1f11a">ost::ctime_r</a> (const time_t *t, char *buf)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">tm * </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceost.html#64c9138a1bf7a0d56fc8060fa1e4552c">ost::gmtime_r</a> (const time_t *t, struct tm *b)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceost.html#6d84108739f29b7fbc773f1a57a3a439">ost::asctime_r</a> (const struct tm *tm, char *b)</td></tr>
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">__EXPORT </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceost.html#1a3b6738f6f759fcb52b544a4787cbb2">ost::Thread</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">__EXPORT </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceost.html#1a0b31279d4e241eba24d251d1682176">ost::ThreadKey</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">__EXPORT </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceost.html#4528eecdfa02ab10dbfdc49f5b238506">ost::Conditional</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">__EXPORT </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceost.html#a1f2ab8ff95e0568261375df5837eb19">ost::Event</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Synchronization and threading services.
<p>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="9fc514088fa3739a1300ce30ca6585d5"></a><!-- doxytag: member="thread.h::CCXX_POSIX" ref="9fc514088fa3739a1300ce30ca6585d5" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define CCXX_POSIX </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="9d5589bc014dcec626ff198d5c9370cd"></a><!-- doxytag: member="thread.h::ENTER_CRITICAL" ref="9d5589bc014dcec626ff198d5c9370cd" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define ENTER_CRITICAL enterMutex(); </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="61438c8055883ef92ffb09c68f70f049"></a><!-- doxytag: member="thread.h::ENTER_DEFERRED" ref="61438c8055883ef92ffb09c68f70f049" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define ENTER_DEFERRED setCancel(cancelDeferred); </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="f1b76aeceb2370c5fcedee46f9cd3d09"></a><!-- doxytag: member="thread.h::LEAVE_CRITICAL" ref="f1b76aeceb2370c5fcedee46f9cd3d09" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define LEAVE_CRITICAL leaveMutex(); </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="c6e53238dd0519d7c7117b2b40d4312b"></a><!-- doxytag: member="thread.h::LEAVE_DEFERRED" ref="c6e53238dd0519d7c7117b2b40d4312b" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define LEAVE_DEFERRED setCancel(cancelImmediate); </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="5e09ab8cba99b274fd420bd76f39b205"></a><!-- doxytag: member="thread.h::psleep" ref="5e09ab8cba99b274fd420bd76f39b205" args="(x)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define psleep </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">x </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> (sleep)(x)</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="74f2d4c747bce0b8f7f7c1f48e651876"></a><!-- doxytag: member="thread.h::TIMEOUT_INF" ref="74f2d4c747bce0b8f7f7c1f48e651876" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define TIMEOUT_INF ~((<a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a>) 0) </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="3f0d0226a694bf1e508e1b1c758e6ae6"></a><!-- doxytag: member="thread.h::cctid_t" ref="3f0d0226a694bf1e508e1b1c758e6ae6" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">typedef pthread_t <a class="el" href="thread_8h.html#3f0d0226a694bf1e508e1b1c758e6ae6">cctid_t</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="f412159e5cef839836a5e7b19ee75d1c"></a><!-- doxytag: member="thread.h::timeout_t" ref="f412159e5cef839836a5e7b19ee75d1c" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">typedef unsigned long <a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:55 2006 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
