aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/reader__writer_8h-source.html
diff options
context:
space:
mode:
authorneodarz <neodarz@neodarz.net>2018-08-11 20:21:34 +0200
committerneodarz <neodarz@neodarz.net>2018-08-11 20:21:34 +0200
commit0ea5fc66924303d1bf73ba283a383e2aadee02f2 (patch)
tree2568e71a7ccc44ec23b8bb3f0ff97fb6bf2ed709 /docs/doxygen/nel/reader__writer_8h-source.html
downloadnevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.tar.xz
nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.zip
Initial commit
Diffstat (limited to 'docs/doxygen/nel/reader__writer_8h-source.html')
-rw-r--r--docs/doxygen/nel/reader__writer_8h-source.html217
1 files changed, 217 insertions, 0 deletions
diff --git a/docs/doxygen/nel/reader__writer_8h-source.html b/docs/doxygen/nel/reader__writer_8h-source.html
new file mode 100644
index 00000000..4583aee1
--- /dev/null
+++ b/docs/doxygen/nel/reader__writer_8h-source.html
@@ -0,0 +1,217 @@
+<!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>&nbsp;<A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A>&nbsp;&nbsp;&nbsp;</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>&nbsp;<A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A>&nbsp;&nbsp;&nbsp;</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>
+&nbsp;
+
+<!-- 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>&nbsp;</td>
+</tr></table>
+<!-- Generated by Doxygen 1.2.14 -->
+<center>
+<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; <a class="qindex" href="pages.html">Related Pages</a> &nbsp; <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> &nbsp; </center>
+<hr><h1>reader_writer.h</h1><a href="reader__writer_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001
+00006 <font class="comment">/* Copyright, 2001 Nevrax Ltd.</font>
+00007 <font class="comment"> *</font>
+00008 <font class="comment"> * This file is part of NEVRAX NEL.</font>
+00009 <font class="comment"> * NEVRAX NEL is free software; you can redistribute it and/or modify</font>
+00010 <font class="comment"> * it under the terms of the GNU General Public License as published by</font>
+00011 <font class="comment"> * the Free Software Foundation; either version 2, or (at your option)</font>
+00012 <font class="comment"> * any later version.</font>
+00013 <font class="comment"></font>
+00014 <font class="comment"> * NEVRAX NEL is distributed in the hope that it will be useful, but</font>
+00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font>
+00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font>
+00017 <font class="comment"> * General Public License for more details.</font>
+00018 <font class="comment"></font>
+00019 <font class="comment"> * You should have received a copy of the GNU General Public License</font>
+00020 <font class="comment"> * along with NEVRAX NEL; see the file COPYING. If not, write to the</font>
+00021 <font class="comment"> * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,</font>
+00022 <font class="comment"> * MA 02111-1307, USA.</font>
+00023 <font class="comment"> */</font>
+00024
+00025 <font class="preprocessor">#ifndef NL_READER_WRITER_H</font>
+00026 <font class="preprocessor"></font><font class="preprocessor">#define NL_READER_WRITER_H</font>
+00027 <font class="preprocessor"></font>
+00028 <font class="preprocessor">#include "<a class="code" href="types__nl_8h.html">nel/misc/types_nl.h</a>"</font>
+00029 <font class="preprocessor">#include "<a class="code" href="mutex_8h.html">nel/misc/mutex.h</a>"</font>
+00030
+00031
+00032 <font class="keyword">namespace </font>NLMISC {
+00033
+<a name="l00040"></a><a class="code" href="classNLMISC_1_1CReaderWriter.html">00040</a> <font class="keyword">class </font>CReaderWriter
+00041 {
+00042 <font class="keyword">private</font>:
+00043
+<a name="l00044"></a><a class="code" href="classNLMISC_1_1CReaderWriter.html#o0">00044</a> <font class="keyword">volatile</font> <a class="code" href="mutex_8h.html#a1">CMutex</a> <a class="code" href="classNLMISC_1_1CReaderWriter.html#o0">_Fairness</a>;
+<a name="l00045"></a><a class="code" href="classNLMISC_1_1CReaderWriter.html#o1">00045</a> <font class="keyword">volatile</font> <a class="code" href="mutex_8h.html#a1">CMutex</a> <a class="code" href="classNLMISC_1_1CReaderWriter.html#o1">_ReadersMutex</a>;
+<a name="l00046"></a><a class="code" href="classNLMISC_1_1CReaderWriter.html#o2">00046</a> <font class="keyword">volatile</font> <a class="code" href="mutex_8h.html#a1">CMutex</a> <a class="code" href="classNLMISC_1_1CReaderWriter.html#o2">_RWMutex</a>;
+<a name="l00047"></a><a class="code" href="classNLMISC_1_1CReaderWriter.html#o3">00047</a> <font class="keyword">volatile</font> sint <a class="code" href="classNLMISC_1_1CReaderWriter.html#o3">_ReadersLevel</a>;
+00048
+00049 <font class="keyword">public</font>:
+00050
+00051 <a class="code" href="classNLMISC_1_1CReaderWriter.html#a0">CReaderWriter</a>();
+00052 <a class="code" href="classNLMISC_1_1CReaderWriter.html#a1">~CReaderWriter</a>();
+00053
+<a name="l00054"></a><a class="code" href="classNLMISC_1_1CReaderWriter.html#a2">00054</a> <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CReaderWriter.html#a2">enterReader</a>()
+00055 {
+00056 const_cast&lt;CMutex&amp;&gt;(_Fairness).enter();
+00057 const_cast&lt;CMutex&amp;&gt;(_ReadersMutex).enter();
+00058 ++<a class="code" href="classNLMISC_1_1CReaderWriter.html#o3">_ReadersLevel</a>;
+00059 <font class="keywordflow">if</font> (<a class="code" href="classNLMISC_1_1CReaderWriter.html#o3">_ReadersLevel</a> == 1)
+00060 const_cast&lt;CMutex&amp;&gt;(_RWMutex).enter();
+00061 const_cast&lt;CMutex&amp;&gt;(_ReadersMutex).leave();
+00062 const_cast&lt;CMutex&amp;&gt;(_Fairness).leave();
+00063 }
+00064
+<a name="l00065"></a><a class="code" href="classNLMISC_1_1CReaderWriter.html#a3">00065</a> <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CReaderWriter.html#a3">leaveReader</a>()
+00066 {
+00067 const_cast&lt;CMutex&amp;&gt;(_ReadersMutex).enter();
+00068 --<a class="code" href="classNLMISC_1_1CReaderWriter.html#o3">_ReadersLevel</a>;
+00069 <font class="keywordflow">if</font> (<a class="code" href="classNLMISC_1_1CReaderWriter.html#o3">_ReadersLevel</a> == 0)
+00070 const_cast&lt;CMutex&amp;&gt;(_RWMutex).leave();
+00071 const_cast&lt;CMutex&amp;&gt;(_ReadersMutex).leave();
+00072 }
+00073
+<a name="l00074"></a><a class="code" href="classNLMISC_1_1CReaderWriter.html#a4">00074</a> <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CReaderWriter.html#a4">enterWriter</a>()
+00075 {
+00076 const_cast&lt;CMutex&amp;&gt;(_Fairness).enter();
+00077 const_cast&lt;CMutex&amp;&gt;(_RWMutex).enter();
+00078 const_cast&lt;CMutex&amp;&gt;(_Fairness).leave();
+00079 }
+00080
+<a name="l00081"></a><a class="code" href="classNLMISC_1_1CReaderWriter.html#a5">00081</a> <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CReaderWriter.html#a5">leaveWriter</a>()
+00082 {
+00083 const_cast&lt;CMutex&amp;&gt;(_RWMutex).leave();
+00084 }
+00085 };
+00086
+00093 <font class="keyword">template</font> &lt;<font class="keyword">class</font> T&gt;
+<a name="l00094"></a><a class="code" href="classNLMISC_1_1CRWSynchronized.html">00094</a> <font class="keyword">class </font>CRWSynchronized
+00095 {
+00096 <font class="keyword">public</font>:
+00097
+<a name="l00098"></a><a class="code" href="classNLMISC_1_1CRWSynchronized_1_1CReadAccessor.html">00098</a> <font class="keyword">class </font>CReadAccessor
+00099 {
+<a name="l00100"></a><a class="code" href="classNLMISC_1_1CRWSynchronized_1_1CReadAccessor.html#o0">00100</a> CRWSynchronized&lt;T&gt; *<a class="code" href="classNLMISC_1_1CRWSynchronized_1_1CReadAccessor.html#o0">_RWSynchronized</a>;
+00101
+00102 <font class="keyword">public</font>:
+00103
+<a name="l00104"></a><a class="code" href="classNLMISC_1_1CRWSynchronized_1_1CReadAccessor.html#a0">00104</a> <a class="code" href="classNLMISC_1_1CRWSynchronized_1_1CReadAccessor.html#a0">CReadAccessor</a>(CRWSynchronized&lt;T&gt; *cs)
+00105 {
+00106 _RWSynchronized = cs;
+00107 const_cast&lt;CReaderWriter&amp;&gt;(_RWSynchronized-&gt;_RWSync).enterReader();
+00108 }
+00109
+<a name="l00110"></a><a class="code" href="classNLMISC_1_1CRWSynchronized_1_1CReadAccessor.html#a1">00110</a> <a class="code" href="classNLMISC_1_1CRWSynchronized_1_1CReadAccessor.html#a1">~CReadAccessor</a>()
+00111 {
+00112 const_cast&lt;CReaderWriter&amp;&gt;(_RWSynchronized-&gt;_RWSync).leaveReader();
+00113 }
+00114
+<a name="l00115"></a><a class="code" href="classNLMISC_1_1CRWSynchronized_1_1CReadAccessor.html#a2">00115</a> <font class="keyword">const</font> T &amp;<a class="code" href="classNLMISC_1_1CRWSynchronized_1_1CReadAccessor.html#a2">value</a>()
+00116 {
+00117 <font class="keywordflow">return</font> const_cast&lt;const T&amp;&gt;(_RWSynchronized-&gt;_Value);
+00118 }
+00119 };
+00120
+<a name="l00121"></a><a class="code" href="classNLMISC_1_1CRWSynchronized_1_1CWriteAccessor.html">00121</a> <font class="keyword">class </font>CWriteAccessor
+00122 {
+<a name="l00123"></a><a class="code" href="classNLMISC_1_1CRWSynchronized_1_1CWriteAccessor.html#o0">00123</a> CRWSynchronized&lt;T&gt; *<a class="code" href="classNLMISC_1_1CRWSynchronized_1_1CWriteAccessor.html#o0">_RWSynchronized</a>;
+00124
+00125 <font class="keyword">public</font>:
+00126
+<a name="l00127"></a><a class="code" href="classNLMISC_1_1CRWSynchronized_1_1CWriteAccessor.html#a0">00127</a> <a class="code" href="classNLMISC_1_1CRWSynchronized_1_1CWriteAccessor.html#a0">CWriteAccessor</a>(CRWSynchronized&lt;T&gt; *cs)
+00128 {
+00129 _RWSynchronized = cs;
+00130 const_cast&lt;CReaderWriter&amp;&gt;(_RWSynchronized-&gt;_RWSync).enterWriter();
+00131 }
+00132
+<a name="l00133"></a><a class="code" href="classNLMISC_1_1CRWSynchronized_1_1CWriteAccessor.html#a1">00133</a> <a class="code" href="classNLMISC_1_1CRWSynchronized_1_1CWriteAccessor.html#a1">~CWriteAccessor</a>()
+00134 {
+00135 const_cast&lt;CReaderWriter&amp;&gt;(_RWSynchronized-&gt;_RWSync).leaveWriter();
+00136 }
+00137
+<a name="l00138"></a><a class="code" href="classNLMISC_1_1CRWSynchronized_1_1CWriteAccessor.html#a2">00138</a> T &amp;<a class="code" href="classNLMISC_1_1CRWSynchronized_1_1CWriteAccessor.html#a2">value</a>()
+00139 {
+00140 <font class="keywordflow">return</font> const_cast&lt;T&amp;&gt;(_RWSynchronized-&gt;_Value);
+00141 }
+00142 };
+00143
+00144 <font class="keyword">private</font>:
+<a name="l00145"></a><a class="code" href="classNLMISC_1_1CRWSynchronized.html#l0">00145</a> <font class="keyword">friend</font> <font class="keyword">class </font>CRWSynchronized::CReadAccessor;
+<a name="l00146"></a><a class="code" href="classNLMISC_1_1CRWSynchronized.html#l1">00146</a> friend class CRWSynchronized::CWriteAccessor;
+00147
+<a name="l00148"></a><a class="code" href="classNLMISC_1_1CRWSynchronized.html#o0">00148</a> volatile CReaderWriter <a class="code" href="classNLMISC_1_1CRWSynchronized.html#o0">_RWSync</a>;
+00149
+<a name="l00150"></a><a class="code" href="classNLMISC_1_1CRWSynchronized.html#o1">00150</a> volatile T <a class="code" href="classNLMISC_1_1CRWSynchronized.html#o1">_Value</a>;
+00151
+00152 };
+00153
+00154 } <font class="comment">// NLMISC</font>
+00155
+00156
+00157 #endif <font class="comment">// NL_READER_WRITER_H</font>
+00158
+00159 <font class="comment">/* End of reader_writer.h */</font>
+</pre></div>
+
+<!-- footer -->
+<BR><FONT Size=+5>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </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>