diff options
| author | neodarz <neodarz@neodarz.net> | 2018-08-11 20:21:34 +0200 |
|---|---|---|
| committer | neodarz <neodarz@neodarz.net> | 2018-08-11 20:21:34 +0200 |
| commit | 0ea5fc66924303d1bf73ba283a383e2aadee02f2 (patch) | |
| tree | 2568e71a7ccc44ec23b8bb3f0ff97fb6bf2ed709 /docs/doxygen/nel/classNLMISC_1_1CUnfairSynchronized.html | |
| download | nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.tar.xz nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.zip | |
Initial commit
Diffstat (limited to '')
| -rw-r--r-- | docs/doxygen/nel/classNLMISC_1_1CUnfairSynchronized.html | 249 |
1 files changed, 249 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLMISC_1_1CUnfairSynchronized.html b/docs/doxygen/nel/classNLMISC_1_1CUnfairSynchronized.html new file mode 100644 index 00000000..43812013 --- /dev/null +++ b/docs/doxygen/nel/classNLMISC_1_1CUnfairSynchronized.html @@ -0,0 +1,249 @@ +<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd"> +<HTML> +<HEAD> + <TITLE>nevrax.org : docs</TITLE> + <LINK REL=stylesheet TYPE="text/css" HREF="http://www.nevrax.org/inc/css/nevrax.css"> + <link href="doxygen.css" rel="stylesheet" type="text/css"> +</HEAD> +<BODY MARGINHEIGHT="0" MARGINWIDTH="0"> + +<!-- uplinks --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A> </TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A> </TD> + </TR> +</TABLE> + +<!-- banner Nevrax --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 WIDTH=100%> + <TR><TD BGCOLOR="#000000" BACKGROUND="http://www.nevrax.org/inc/img/black_banner.jpg"><A HREF="http://www.nevrax.org"><IMG SRC="http://www.nevrax.org/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR> +</TABLE> + +<!-- main table --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 height=100%> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + + <!------ Begin Box ------> + <TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0 cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black> + <FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td colspan=2 bgcolor=#FFFFFF> + <TABLE cellspacing=0 cellpadding=1 border=0> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="Rubrique news"><img width=13 height=15 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-news.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="News">News</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Rubrique mail"><img width=15 height=11 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-mail.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Rubrique docs"><img width=14 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-docs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Documentation">Documentation</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="Rubrique cvs"><img width=13 height=17 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-cvs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="CVS Web">CVS</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Rubrique bugs"><img width=20 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-bugs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Bugtracking">Bugs</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="Rubrique license"><img width=18 height=12 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-gpl.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="License">License</a></td></tr> + </TABLE> + </TD></TR></TABLE></TD></TR></TABLE> + <!------ End Box ------> + + </TD> + <TD WIDTH=15><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD ALIGN=left valign=top><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + +<!-- title --> +<TABLE background="http://www.nevrax.org/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td> +<A HREF="http://www.nevrax.org/docs/"><img src="http://www.nevrax.org/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A> +</td><td><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT=""> +</td></tr></table> + + +<!-- block --> +<TABLE bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="http://www.nevrax.org/inc/img/reddots.gif"></TD> + <TD><B>Documentation</B></TD> + <TD ALIGN=RIGHT> </td> +</tr></table> +<!-- Generated by Doxygen 1.2.14 --> +<center> +<a class="qindex" href="index.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">Compound List</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">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindexRef" doxygen="_cgi:http://www.nevrax.org/cgi-bin/nel-search.cgi" href="http://www.nevrax.org/cgi-bin/nel-search.cgi">Search</a> </center> +<hr><h1>NLMISC::CUnfairSynchronized Class Template Reference</h1>This class ensure that the Value is accessed by only one thread. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="mutex_8h-source.html">mutex.h</a>></code> +<p> +<a href="classNLMISC_1_1CUnfairSynchronized-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classNLMISC_1_1CUnfairSynchronized.html#a0">CUnfairSynchronized</a> (const std::string &name)</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top>volatile <a class="el" href="classNLMISC_1_1CUnfairMutex.html">CUnfairMutex</a> </td><td valign=bottom><a class="el" href="classNLMISC_1_1CUnfairSynchronized.html#o0">_Mutex</a></td></tr> +<tr><td> </td><td><font size=-1><em>The mutex of the synchronized value.</em> <a href="#o0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>volatile T </td><td valign=bottom><a class="el" href="classNLMISC_1_1CUnfairSynchronized.html#o1">_Value</a></td></tr> +<tr><td> </td><td><font size=-1><em>The synchronized value.</em> <a href="#o1">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Friends</h2></td></tr> +<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classNLMISC_1_1CUnfairSynchronized.html#l0">CUnfairSynchronized::CAccessor</a></td></tr> +</table> +<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. +<p> +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="classNLMISC_1_1CUnfairSynchronized_1_1CAccessor.html">CAccessor</a> in a <b>sub</b> <b>scope</b>. You can modify the value of the <a class="el" href="classNLMISC_1_1CUnfairSynchronized.html">CUnfairSynchronized</a> using the <a class="el" href="driver__opengl__extension__def_8h.html#a415">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="classNLMISC_1_1CUnfairMutex.html">CUnfairMutex</a> object (see <a class="el" href="classNLMISC_1_1CUnfairMutex.html">CUnfairMutex</a> for programming considerations). +<p> +<div class="fragment"><pre> <font class="comment">// the value that you want to be thread safe.</font> + CUnfairSynchronized<int> val; + { <font class="comment">// create a new scope for the access</font> + <font class="comment">// get an access to the value</font> + CUnfairSynchronized<int>::CAccessor acces(&val); + <font 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</font> + acces.value () = 10; + } <font class="comment">// end of the access</font> + * +</pre></div> <dl compact><dt><b> +Author: </b><dd> +Vianney Lecroart , Nevrax France </dl><dl compact><dt><b> +Date: </b><dd> +2000 </dl> +<p> + +<p> +Definition at line <a class="el" href="mutex_8h-source.html#l00393">393</a> of file <a class="el" href="mutex_8h-source.html">mutex.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="NLMISC::CUnfairSynchronized::CUnfairSynchronized"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <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"> NLMISC::CUnfairSynchronized< T >::CUnfairSynchronized </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="mutex_8h-source.html#l00397">397</a> of file <a class="el" href="mutex_8h-source.html">mutex.h</a>. +<p> +References <a class="el" href="mutex_8h-source.html#l00432">_Mutex</a>. </td> + </tr> +</table> +<hr><h2>Friends And Related Function Documentation</h2> +<a name="l0" doxytag="NLMISC::CUnfairSynchronized::CUnfairSynchronized::CAccessor"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <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 CUnfairSynchronized::CAccessor<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="mutex_8h-source.html#l00429">429</a> of file <a class="el" href="mutex_8h-source.html">mutex.h</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="o0" doxytag="NLMISC::CUnfairSynchronized::_Mutex"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <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="classNLMISC_1_1CUnfairMutex.html">CUnfairMutex</a> NLMISC::CUnfairSynchronized::_Mutex<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="mutex_8h-source.html#l00432">432</a> of file <a class="el" href="mutex_8h-source.html">mutex.h</a>. +<p> +Referenced by <a class="el" href="mutex_8h-source.html#l00397">CUnfairSynchronized</a>. </td> + </tr> +</table> +<a name="o1" doxytag="NLMISC::CUnfairSynchronized::_Value"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <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 NLMISC::CUnfairSynchronized::_Value<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="mutex_8h-source.html#l00435">435</a> of file <a class="el" href="mutex_8h-source.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="mutex_8h-source.html">mutex.h</a></ul> + + +<!-- footer --> +<BR><FONT Size=+5> </FONT> +</TD> +<TD WIDTH=15><IMG SRC=http://www.nevrax.org/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD> +</TR> +</TABLE> +</BODY> +</HTML> |