aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/a02856.html
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/doxygen/nel/a02856.html252
1 files changed, 252 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a02856.html b/docs/doxygen/nel/a02856.html
new file mode 100644
index 00000000..b2188568
--- /dev/null
+++ b/docs/doxygen/nel/a02856.html
@@ -0,0 +1,252 @@
+<!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>NeL: NLMEMORY::CMemoryTDS class Reference</title>
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.3.6 -->
+<div class="qindex"> <form class="search" action="search.php" method="get">
+<a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a> | <span class="search"><u>S</u>earch&nbsp;for&nbsp;<input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
+<h1>NLMEMORY::CMemoryTDS Class Reference</h1><code>#include &lt;<a class="el" href="a05988.html">memory_tds.h</a>&gt;</code>
+<p>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+Thread dependant storage class<p>
+This class provides a thread specific (void*). It is initialized at NULL.<p>
+<dl compact><dt><b>Author:</b></dt><dd>Cyril 'Hulud' Corvazier <p>
+Nevrax France </dd></dl>
+<dl compact><dt><b>Date:</b></dt><dd>2002 </dd></dl>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="a05988.html#l00044">44</a> of file <a class="el" href="a05988.html">memory_tds.h</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>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02856.html#NLMEMORY_1_1CMemoryTDSa0">CMemoryTDS</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. The pointer is initialized with NULL. <a href="#NLMEMORY_1_1CMemoryTDSa0"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>void *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02856.html#NLMEMORY_1_1CMemoryTDSa1">getPointer</a> () const </td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the thread specific pointer. <a href="#NLMEMORY_1_1CMemoryTDSa1"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02856.html#NLMEMORY_1_1CMemoryTDSa2">setPointer</a> (void *<a class="el" href="a04223.html#a570">pointer</a>)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the thread specific pointer. <a href="#NLMEMORY_1_1CMemoryTDSa2"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02856.html#NLMEMORY_1_1CMemoryTDSa3">~CMemoryTDS</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#NLMEMORY_1_1CMemoryTDSa3"></a><br><br></td></tr>
+<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>pthread_key_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02856.html#NLMEMORY_1_1CMemoryTDSr0">_Key</a></td></tr>
+
+</table>
+<hr><h2>Constructor &amp; Destructor Documentation</h2>
+<a class="anchor" name="NLMEMORY_1_1CMemoryTDSa0" doxytag="NLMEMORY::CMemoryTDS::CMemoryTDS" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> NLMEMORY::CMemoryTDS::CMemoryTDS </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Constructor. The pointer is initialized with NULL.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05987.html#l00043">43</a> of file <a class="el" href="a05987.html">memory_tds.cpp</a>.
+<p>
+References <a class="el" href="a05988.html#l00064">_Key</a>.
+<p>
+<div class="fragment"><pre>00044 {
+00045 <span class="comment">/* Please no assert in the constructor because it is called by the NeL memory allocator constructor */</span>
+00046 <span class="preprocessor">#ifdef NL_OS_WINDOWS</span>
+00047 <span class="preprocessor"></span> _Handle = TlsAlloc ();
+00048 TlsSetValue (_Handle, NULL);
+00049 <span class="preprocessor">#else // NL_OS_WINDOWS</span>
+00050 <span class="preprocessor"></span> <a class="code" href="a02856.html#NLMEMORY_1_1CMemoryTDSr0">_Key</a> = pthread_key_create (&amp;_Key, 0);
+00051 pthread_setspecific(_Key, 0);
+00052 <span class="preprocessor">#endif // NL_OS_WINDOWS</span>
+00053 <span class="preprocessor"></span>}
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLMEMORY_1_1CMemoryTDSa3" doxytag="NLMEMORY::CMemoryTDS::~CMemoryTDS" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> NLMEMORY::CMemoryTDS::~<a class="el" href="a02856.html">CMemoryTDS</a> </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Destructor.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05987.html#l00057">57</a> of file <a class="el" href="a05987.html">memory_tds.cpp</a>.
+<p>
+References <a class="el" href="a05988.html#l00064">_Key</a>.
+<p>
+<div class="fragment"><pre>00058 {
+00059 <span class="preprocessor">#ifdef NL_OS_WINDOWS</span>
+00060 <span class="preprocessor"></span> TlsFree (_Handle);
+00061 <span class="preprocessor">#else // NL_OS_WINDOWS</span>
+00062 <span class="preprocessor"></span> pthread_key_delete (_Key);
+00063 <span class="preprocessor">#endif // NL_OS_WINDOWS</span>
+00064 <span class="preprocessor"></span>}
+</pre></div> </td>
+ </tr>
+</table>
+<hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="NLMEMORY_1_1CMemoryTDSa1" doxytag="NLMEMORY::CMemoryTDS::getPointer" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> void * NLMEMORY::CMemoryTDS::getPointer </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap> const</td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Get the thread specific pointer.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05987.html#l00068">68</a> of file <a class="el" href="a05987.html">memory_tds.cpp</a>.
+<p>
+References <a class="el" href="a05988.html#l00064">_Key</a>.
+<p>
+<div class="fragment"><pre>00069 {
+00070 <span class="preprocessor">#ifdef NL_OS_WINDOWS</span>
+00071 <span class="preprocessor"></span> <span class="keywordflow">return</span> TlsGetValue (_Handle);
+00072 <span class="preprocessor">#else // NL_OS_WINDOWS</span>
+00073 <span class="preprocessor"></span> <span class="keywordflow">return</span> pthread_getspecific (_Key);
+00074 <span class="preprocessor">#endif // NL_OS_WINDOWS</span>
+00075 <span class="preprocessor"></span>}
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLMEMORY_1_1CMemoryTDSa2" doxytag="NLMEMORY::CMemoryTDS::setPointer" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> void NLMEMORY::CMemoryTDS::setPointer </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">void *&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> <em>pointer</em> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Set the thread specific pointer.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05987.html#l00079">79</a> of file <a class="el" href="a05987.html">memory_tds.cpp</a>.
+<p>
+References <a class="el" href="a05988.html#l00064">_Key</a>, and <a class="el" href="a05646.html#l00233">pointer</a>.
+<p>
+<div class="fragment"><pre>00080 {
+00081 <span class="preprocessor">#ifdef NL_OS_WINDOWS</span>
+00082 <span class="preprocessor"></span> TlsSetValue (_Handle, pointer);
+00083 <span class="preprocessor">#else // NL_OS_WINDOWS</span>
+00084 <span class="preprocessor"></span> pthread_setspecific (_Key, pointer);
+00085 <span class="preprocessor">#endif // NL_OS_WINDOWS</span>
+00086 <span class="preprocessor"></span>}
+</pre></div> </td>
+ </tr>
+</table>
+<hr><h2>Field Documentation</h2>
+<a class="anchor" name="NLMEMORY_1_1CMemoryTDSr0" doxytag="NLMEMORY::CMemoryTDS::_Key" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> pthread_key_t <a class="el" href="a02856.html#NLMEMORY_1_1CMemoryTDSr0">NLMEMORY::CMemoryTDS::_Key</a><code> [private]</code>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="a05988.html#l00064">64</a> of file <a class="el" href="a05988.html">memory_tds.h</a>.
+<p>
+Referenced by <a class="el" href="a05987.html#l00043">CMemoryTDS()</a>, <a class="el" href="a05987.html#l00068">getPointer()</a>, <a class="el" href="a05987.html#l00079">setPointer()</a>, and <a class="el" href="a05987.html#l00057">~CMemoryTDS()</a>. </td>
+ </tr>
+</table>
+<hr>The documentation for this class was generated from the following files:<ul>
+<li><a class="el" href="a05988.html">memory_tds.h</a><li><a class="el" href="a05987.html">memory_tds.cpp</a></ul>
+<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 12:56:53 2004 for NeL by
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
+</a>1.3.6 </small></address>
+</body>
+</html>