aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/a03318.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/doxygen/nel/a03318.html')
-rw-r--r--docs/doxygen/nel/a03318.html390
1 files changed, 390 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03318.html b/docs/doxygen/nel/a03318.html
new file mode 100644
index 00000000..c9bac702
--- /dev/null
+++ b/docs/doxygen/nel/a03318.html
@@ -0,0 +1,390 @@
+<!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: NLMISC::CReaderWriter 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>NLMISC::CReaderWriter Class Reference</h1><code>#include &lt;<a class="el" href="a06318.html">reader_writer.h</a>&gt;</code>
+<p>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+This class allows a reader/writer ressource usage policy. <dl compact><dt><b>Author:</b></dt><dd>Benjamin Legros <p>
+Nevrax France </dd></dl>
+<dl compact><dt><b>Date:</b></dt><dd>2001 </dd></dl>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="a06318.html#l00040">40</a> of file <a class="el" href="a06318.html">reader_writer.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="a03318.html#NLMISC_1_1CReaderWritera0">CReaderWriter</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03318.html#NLMISC_1_1CReaderWritera1">enterReader</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03318.html#NLMISC_1_1CReaderWritera2">enterWriter</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03318.html#NLMISC_1_1CReaderWritera3">leaveReader</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03318.html#NLMISC_1_1CReaderWritera4">leaveWriter</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03318.html#NLMISC_1_1CReaderWritera5">~CReaderWriter</a> ()</td></tr>
+
+<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>volatile CMutex&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03318.html#NLMISC_1_1CReaderWriterr0">_Fairness</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>volatile <a class="el" href="a04558.html#a14">sint</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03318.html#NLMISC_1_1CReaderWriterr1">_ReadersLevel</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>volatile CMutex&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03318.html#NLMISC_1_1CReaderWriterr2">_ReadersMutex</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>volatile CMutex&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03318.html#NLMISC_1_1CReaderWriterr3">_RWMutex</a></td></tr>
+
+</table>
+<hr><h2>Constructor &amp; Destructor Documentation</h2>
+<a class="anchor" name="NLMISC_1_1CReaderWritera0" doxytag="NLMISC::CReaderWriter::CReaderWriter" ></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"> NLMISC::CReaderWriter::CReaderWriter </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>
+
+<p>
+Definition at line <a class="el" href="a06317.html#l00032">32</a> of file <a class="el" href="a06317.html">reader_writer.cpp</a>.
+<p>
+References <a class="el" href="a06318.html#l00047">_ReadersLevel</a>.
+<p>
+<div class="fragment"><pre>00033 {
+00034 <a class="code" href="a03318.html#NLMISC_1_1CReaderWriterr1">_ReadersLevel</a> = 0;
+00035 }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLMISC_1_1CReaderWritera5" doxytag="NLMISC::CReaderWriter::~CReaderWriter" ></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"> NLMISC::CReaderWriter::~<a class="el" href="a03318.html">CReaderWriter</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>
+
+<p>
+Definition at line <a class="el" href="a06317.html#l00037">37</a> of file <a class="el" href="a06317.html">reader_writer.cpp</a>.
+<p>
+<div class="fragment"><pre>00038 {
+00039 <span class="comment">// here some checks to avoid a reader/writer still working while we flush the mutexes...</span>
+00040 }
+</pre></div> </td>
+ </tr>
+</table>
+<hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="NLMISC_1_1CReaderWritera1" doxytag="NLMISC::CReaderWriter::enterReader" ></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 NLMISC::CReaderWriter::enterReader </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><code> [inline]</code></td>
+ </tr>
+
+ </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="a06318.html#l00054">54</a> of file <a class="el" href="a06318.html">reader_writer.h</a>.
+<p>
+References <a class="el" href="a06318.html#l00044">_Fairness</a>, <a class="el" href="a06318.html#l00047">_ReadersLevel</a>, <a class="el" href="a06318.html#l00045">_ReadersMutex</a>, and <a class="el" href="a06318.html#l00046">_RWMutex</a>.
+<p>
+<div class="fragment"><pre>00055 {
+00056 const_cast&lt;CMutex&amp;&gt;(<a class="code" href="a03318.html#NLMISC_1_1CReaderWriterr0">_Fairness</a>).enter();
+00057 const_cast&lt;CMutex&amp;&gt;(<a class="code" href="a03318.html#NLMISC_1_1CReaderWriterr2">_ReadersMutex</a>).enter();
+00058 ++<a class="code" href="a03318.html#NLMISC_1_1CReaderWriterr1">_ReadersLevel</a>;
+00059 <span class="keywordflow">if</span> (<a class="code" href="a03318.html#NLMISC_1_1CReaderWriterr1">_ReadersLevel</a> == 1)
+00060 const_cast&lt;CMutex&amp;&gt;(<a class="code" href="a03318.html#NLMISC_1_1CReaderWriterr3">_RWMutex</a>).enter();
+00061 const_cast&lt;CMutex&amp;&gt;(<a class="code" href="a03318.html#NLMISC_1_1CReaderWriterr2">_ReadersMutex</a>).leave();
+00062 const_cast&lt;CMutex&amp;&gt;(<a class="code" href="a03318.html#NLMISC_1_1CReaderWriterr0">_Fairness</a>).leave();
+00063 }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLMISC_1_1CReaderWritera2" doxytag="NLMISC::CReaderWriter::enterWriter" ></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 NLMISC::CReaderWriter::enterWriter </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><code> [inline]</code></td>
+ </tr>
+
+ </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="a06318.html#l00074">74</a> of file <a class="el" href="a06318.html">reader_writer.h</a>.
+<p>
+References <a class="el" href="a06318.html#l00044">_Fairness</a>, and <a class="el" href="a06318.html#l00046">_RWMutex</a>.
+<p>
+<div class="fragment"><pre>00075 {
+00076 const_cast&lt;CMutex&amp;&gt;(<a class="code" href="a03318.html#NLMISC_1_1CReaderWriterr0">_Fairness</a>).enter();
+00077 const_cast&lt;CMutex&amp;&gt;(<a class="code" href="a03318.html#NLMISC_1_1CReaderWriterr3">_RWMutex</a>).enter();
+00078 const_cast&lt;CMutex&amp;&gt;(<a class="code" href="a03318.html#NLMISC_1_1CReaderWriterr0">_Fairness</a>).leave();
+00079 }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLMISC_1_1CReaderWritera3" doxytag="NLMISC::CReaderWriter::leaveReader" ></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 NLMISC::CReaderWriter::leaveReader </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><code> [inline]</code></td>
+ </tr>
+
+ </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="a06318.html#l00065">65</a> of file <a class="el" href="a06318.html">reader_writer.h</a>.
+<p>
+References <a class="el" href="a06318.html#l00047">_ReadersLevel</a>, <a class="el" href="a06318.html#l00045">_ReadersMutex</a>, and <a class="el" href="a06318.html#l00046">_RWMutex</a>.
+<p>
+<div class="fragment"><pre>00066 {
+00067 const_cast&lt;CMutex&amp;&gt;(<a class="code" href="a03318.html#NLMISC_1_1CReaderWriterr2">_ReadersMutex</a>).enter();
+00068 --<a class="code" href="a03318.html#NLMISC_1_1CReaderWriterr1">_ReadersLevel</a>;
+00069 <span class="keywordflow">if</span> (<a class="code" href="a03318.html#NLMISC_1_1CReaderWriterr1">_ReadersLevel</a> == 0)
+00070 const_cast&lt;CMutex&amp;&gt;(<a class="code" href="a03318.html#NLMISC_1_1CReaderWriterr3">_RWMutex</a>).leave();
+00071 const_cast&lt;CMutex&amp;&gt;(<a class="code" href="a03318.html#NLMISC_1_1CReaderWriterr2">_ReadersMutex</a>).leave();
+00072 }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLMISC_1_1CReaderWritera4" doxytag="NLMISC::CReaderWriter::leaveWriter" ></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 NLMISC::CReaderWriter::leaveWriter </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><code> [inline]</code></td>
+ </tr>
+
+ </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="a06318.html#l00081">81</a> of file <a class="el" href="a06318.html">reader_writer.h</a>.
+<p>
+References <a class="el" href="a06318.html#l00046">_RWMutex</a>.
+<p>
+<div class="fragment"><pre>00082 {
+00083 const_cast&lt;CMutex&amp;&gt;(<a class="code" href="a03318.html#NLMISC_1_1CReaderWriterr3">_RWMutex</a>).leave();
+00084 }
+</pre></div> </td>
+ </tr>
+</table>
+<hr><h2>Field Documentation</h2>
+<a class="anchor" name="NLMISC_1_1CReaderWriterr0" doxytag="NLMISC::CReaderWriter::_Fairness" ></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"> volatile CMutex <a class="el" href="a03318.html#NLMISC_1_1CReaderWriterr0">NLMISC::CReaderWriter::_Fairness</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="a06318.html#l00044">44</a> of file <a class="el" href="a06318.html">reader_writer.h</a>.
+<p>
+Referenced by <a class="el" href="a06318.html#l00054">enterReader()</a>, and <a class="el" href="a06318.html#l00074">enterWriter()</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NLMISC_1_1CReaderWriterr1" doxytag="NLMISC::CReaderWriter::_ReadersLevel" ></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"> volatile <a class="el" href="a04558.html#a14">sint</a> <a class="el" href="a03318.html#NLMISC_1_1CReaderWriterr1">NLMISC::CReaderWriter::_ReadersLevel</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="a06318.html#l00047">47</a> of file <a class="el" href="a06318.html">reader_writer.h</a>.
+<p>
+Referenced by <a class="el" href="a06317.html#l00032">CReaderWriter()</a>, <a class="el" href="a06318.html#l00054">enterReader()</a>, and <a class="el" href="a06318.html#l00065">leaveReader()</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NLMISC_1_1CReaderWriterr2" doxytag="NLMISC::CReaderWriter::_ReadersMutex" ></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"> volatile CMutex <a class="el" href="a03318.html#NLMISC_1_1CReaderWriterr2">NLMISC::CReaderWriter::_ReadersMutex</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="a06318.html#l00045">45</a> of file <a class="el" href="a06318.html">reader_writer.h</a>.
+<p>
+Referenced by <a class="el" href="a06318.html#l00054">enterReader()</a>, and <a class="el" href="a06318.html#l00065">leaveReader()</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NLMISC_1_1CReaderWriterr3" doxytag="NLMISC::CReaderWriter::_RWMutex" ></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"> volatile CMutex <a class="el" href="a03318.html#NLMISC_1_1CReaderWriterr3">NLMISC::CReaderWriter::_RWMutex</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="a06318.html#l00046">46</a> of file <a class="el" href="a06318.html">reader_writer.h</a>.
+<p>
+Referenced by <a class="el" href="a06318.html#l00054">enterReader()</a>, <a class="el" href="a06318.html#l00074">enterWriter()</a>, <a class="el" href="a06318.html#l00065">leaveReader()</a>, and <a class="el" href="a06318.html#l00081">leaveWriter()</a>. </td>
+ </tr>
+</table>
+<hr>The documentation for this class was generated from the following files:<ul>
+<li><a class="el" href="a06318.html">reader_writer.h</a><li><a class="el" href="a06317.html">reader_writer.cpp</a></ul>
+<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 13:31:11 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>