<!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++: ost::ThreadKey Class 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 id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><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="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_thread_key.html">ThreadKey</a></div>
<h1>ost::ThreadKey Class Reference</h1><!-- doxytag: class="ost::ThreadKey" -->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="#_details">More...</a>
<p>
<code>#include <<a class="el" href="thread_8h-source.html">thread.h</a>></code>
<p>
<a href="classost_1_1_thread_key-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_key.html#043483c6c7621ecea587d7c241dea50c">ThreadKey</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a unique thread specific container. <a href="#043483c6c7621ecea587d7c241dea50c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_key.html#e2450333089e61ce432377977fc1e337">~ThreadKey</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a thread specific container and any contents reserved. <a href="#e2450333089e61ce432377977fc1e337"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_key.html#3b59c3887d643ce80af170663cb2551c">getKey</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of the pointer for the thread specific data container. <a href="#3b59c3887d643ce80af170663cb2551c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_key.html#5569af7b992aa2fb67da7711225c99a6">setKey</a> (void *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the value of the pointer for the current thread specific execution context. <a href="#5569af7b992aa2fb67da7711225c99a6"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</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_thread_key.html#e3c1cdb20d70b22a5c0bf395614eefff">ThreadImpl</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
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.
<p>
Finally, Common C++ supports a thread-safe "AtomicCounter" class. This can often be used for reference counting without having to protect the counter with a separate <a class="el" href="classost_1_1_mutex.html">Mutex</a> counter. This lends to lighter-weight code.<p>
<dl compact><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> </dd></dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="043483c6c7621ecea587d7c241dea50c"></a><!-- doxytag: member="ost::ThreadKey::ThreadKey" ref="043483c6c7621ecea587d7c241dea50c" 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">ost::ThreadKey::ThreadKey </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create a unique thread specific container.
<p>
</td>
</tr>
</table>
<a class="anchor" name="e2450333089e61ce432377977fc1e337"></a><!-- doxytag: member="ost::ThreadKey::~ThreadKey" ref="e2450333089e61ce432377977fc1e337" 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">virtual ost::ThreadKey::~ThreadKey </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Destroy a thread specific container and any contents reserved.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="3b59c3887d643ce80af170663cb2551c"></a><!-- doxytag: member="ost::ThreadKey::getKey" ref="3b59c3887d643ce80af170663cb2551c" args="(void)" --><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">void* ost::ThreadKey::getKey </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the value of the pointer for the thread specific data container.
<p>
A unique pointer can be set for each execution context.<p>
<dl compact><dt><b>Returns:</b></dt><dd>a unique void * for each execution context. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="5569af7b992aa2fb67da7711225c99a6"></a><!-- doxytag: member="ost::ThreadKey::setKey" ref="5569af7b992aa2fb67da7711225c99a6" args="(void *)" --><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">void ost::ThreadKey::setKey </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void * </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the value of the pointer for the current thread specific execution context.
<p>
This can be used to store thread context specific data.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>-</em> </td><td>ptr to thread context specific data. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="e3c1cdb20d70b22a5c0bf395614eefff"></a><!-- doxytag: member="ost::ThreadKey::ThreadImpl" ref="e3c1cdb20d70b22a5c0bf395614eefff" 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">friend class ThreadImpl<code> [friend]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="thread_8h-source.html">thread.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:57 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>
