diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/doxygen/nel/a03630.html | 185 |
1 files changed, 185 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03630.html b/docs/doxygen/nel/a03630.html new file mode 100644 index 00000000..2b361bd9 --- /dev/null +++ b/docs/doxygen/nel/a03630.html @@ -0,0 +1,185 @@ +<!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: TemplateNLMISC::CUnfairSynchronized< T > 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 Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a> | <span class="search"><u>S</u>earch for <input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div> +<h1>NLMISC::CUnfairSynchronized< T > Class Template Reference</h1><code>#include <<a class="el" href="a06088.html">mutex.h</a>></code> +<p> +<hr><a name="_details"></a><h2>Detailed Description</h2> +<h3>template<class T><br> + class NLMISC::CUnfairSynchronized< T ></h3> + +This class ensure that the Value is accessed by only one thread. First you have to create a CSynchronized class with you type. Then, if a thread want to modify or do anything on it, you create a <a class="el" href="a03631.html">CAccessor</a> in a <b>sub</b> <b>scope</b>. You can modify the value of the <a class="el" href="a03630.html">CUnfairSynchronized</a> using the <a class="el" href="a04223.html#a658">value()</a> function <b>until</b> the end of the scope. So you have to put the smaller scope as you can.<p> +Internally, this class uses a <a class="el" href="a03629.html">CUnfairMutex</a> object (see <a class="el" href="a03629.html">CUnfairMutex</a> for programming considerations).<p> +<pre class="fragment"><div> <span class="comment">// the value that you want to be thread safe.</span> + CUnfairSynchronized<int> val; + { <span class="comment">// create a new scope for the access</span> + <span class="comment">// get an access to the value</span> + CUnfairSynchronized<int>::CAccessor acces(&val); + <span class="comment">// now, you have a thread safe access until the end of the scope, so you can do whatever you want. for example, change the value</span> + acces.value () = 10; + } <span class="comment">// end of the access</span> + * +</div></pre><dl compact><dt><b>Author:</b></dt><dd>Vianney Lecroart <p> +Nevrax France </dd></dl> +<dl compact><dt><b>Date:</b></dt><dd>2000 </dd></dl> + +<p> + +<p> +Definition at line <a class="el" href="a06088.html#l00587">587</a> of file <a class="el" href="a06088.html">mutex.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> </td><td class="memItemRight" valign=bottom><a class="el" href="a03630.html#NLMISC_1_1CUnfairSynchronizeda0">CUnfairSynchronized</a> (const std::string &name)</td></tr> + +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>volatile <a class="el" href="a03629.html">CUnfairMutex</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03630.html#NLMISC_1_1CUnfairSynchronizedr0">_Mutex</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The mutex of the synchronized value. <a href="#NLMISC_1_1CUnfairSynchronizedr0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>volatile T </td><td class="memItemRight" valign=bottom><a class="el" href="a03630.html#NLMISC_1_1CUnfairSynchronizedr1">_Value</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The synchronized value. <a href="#NLMISC_1_1CUnfairSynchronizedr1"></a><br><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="a03630.html#NLMISC_1_1CUnfairSynchronizedn0">CUnfairSynchronized::CAccessor</a></td></tr> + +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="NLMISC_1_1CUnfairSynchronizeda0" doxytag="NLMISC::CUnfairSynchronized::CUnfairSynchronized" ></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" colspan="4"> +template<class T> </td> + </tr> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="a03630.html">NLMISC::CUnfairSynchronized</a>< T >::<a class="el" href="a03630.html">CUnfairSynchronized</a> </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>name</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a06088.html#l00591">591</a> of file <a class="el" href="a06088.html">mutex.h</a>. +<p> +<div class="fragment"><pre>00591 : <a class="code" href="a03630.html#NLMISC_1_1CUnfairSynchronizedr0">_Mutex</a>(name) { } +</pre></div> </td> + </tr> +</table> +<hr><h2>Friends And Related Function Documentation</h2> +<a class="anchor" name="NLMISC_1_1CUnfairSynchronizedn0" doxytag="NLMISC::CUnfairSynchronized::CUnfairSynchronized::CAccessor" ></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" colspan="4"> +template<class T> </td> + </tr> + <tr> + <td class="md" nowrap valign="top"> friend class <a class="el" href="a03631.html">CUnfairSynchronized::CAccessor</a><code> [friend]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a06088.html#l00623">623</a> of file <a class="el" href="a06088.html">mutex.h</a>. </td> + </tr> +</table> +<hr><h2>Field Documentation</h2> +<a class="anchor" name="NLMISC_1_1CUnfairSynchronizedr0" doxytag="NLMISC::CUnfairSynchronized::_Mutex" ></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" colspan="4"> +template<class T> </td> + </tr> + <tr> + <td class="md" nowrap valign="top"> volatile <a class="el" href="a03629.html">CUnfairMutex</a> <a class="el" href="a03630.html">NLMISC::CUnfairSynchronized</a>< T >::<a class="el" href="a03630.html#NLMISC_1_1CUnfairSynchronizedr0">_Mutex</a><code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The mutex of the synchronized value. +<p> + +<p> +Definition at line <a class="el" href="a06088.html#l00626">626</a> of file <a class="el" href="a06088.html">mutex.h</a>. </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1CUnfairSynchronizedr1" doxytag="NLMISC::CUnfairSynchronized::_Value" ></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" colspan="4"> +template<class T> </td> + </tr> + <tr> + <td class="md" nowrap valign="top"> volatile T <a class="el" href="a03630.html">NLMISC::CUnfairSynchronized</a>< T >::<a class="el" href="a03630.html#NLMISC_1_1CUnfairSynchronizedr1">_Value</a><code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The synchronized value. +<p> + +<p> +Definition at line <a class="el" href="a06088.html#l00629">629</a> of file <a class="el" href="a06088.html">mutex.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="a06088.html">mutex.h</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 13:39:21 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> |