added doxygen generatet documentation

author: Erwin Nindl <nine@wirdorange.org> 2007-10-07 22:07:03 +0000
committer: Erwin Nindl <nine@wirdorange.org> 2007-10-07 22:07:03 +0000
commit: 7763f07327f3abce839a690df46ced3bfd1d3d09 (patch)
tree: c80abe2cf8e137edba89cad9f14f63048275cee1 /doc/html/classSeqWindow.html
parent: added doxygen, and doxygen makefile target (diff)
1 files changed, 340 insertions, 0 deletions
diff --git a/doc/html/classSeqWindow.html b/doc/html/classSeqWindow.html
new file mode 100644
index 0000000..4e2bd78
--- /dev/null
+++ b/doc/html/classSeqWindow.html
@@ -0,0 +1,340 @@
+<!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>anytun: SeqWindow Class Reference</title>
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+<link href="tabs.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.1 -->
+<div class="tabs">
+  <ul>
+    <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
+    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+    <li id="current"><a href="annotated.html"><span>Classes</span></a></li>
+    <li><a href="files.html"><span>Files</span></a></li>
+  </ul></div>
+<div class="tabs">
+  <ul>
+    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
+    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+  </ul></div>
+<h1>SeqWindow Class Reference</h1><!-- doxytag: class="SeqWindow" --><code>#include &lt;<a class="el" href="seqWindow_8h-source.html">seqWindow.h</a>&gt;</code>
+<p>
+<a href="classSeqWindow-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::deque&lt; <a class="el" href="datatypes_8h.html#317be74a3176b4149a817241bd69f9b2">seq_nr_t</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSeqWindow.html#cf2d07003c8ca868146cffb4dd1d5ca7">SeqDeque</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::map&lt; <a class="el" href="datatypes_8h.html#c8be006c348a522ae126f67f7b2aaf4e">sender_id_t</a>,<br>
+ <a class="el" href="classSeqWindow.html#cf2d07003c8ca868146cffb4dd1d5ca7">SeqDeque</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSeqWindow.html#127195f139c8d5d07ed93799c2d6821a">SenderMap</a></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="classSeqWindow.html#8d513ab9ef2984ea93dad7e4026185c8">SeqWindow</a> (<a class="el" href="datatypes_8h.html#0246b9fac0b861d94e0e4cc9ae2e5070">window_size_t</a> w)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSeqWindow.html#d125bcc4751a746427f04dda7fd65a10">~SeqWindow</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">SeqDeque::size_type&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSeqWindow.html#5d39959927c79c54d133ed77b297ad7c">getLength</a> (<a class="el" href="datatypes_8h.html#c8be006c348a522ae126f67f7b2aaf4e">sender_id_t</a> sender)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSeqWindow.html#9e7714dda181863420c38975bd505aff">hasSeqNr</a> (<a class="el" href="datatypes_8h.html#c8be006c348a522ae126f67f7b2aaf4e">sender_id_t</a> sender, <a class="el" href="datatypes_8h.html#317be74a3176b4149a817241bd69f9b2">seq_nr_t</a> seq)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSeqWindow.html#255ca0fca3e701bd9e18d9fcb2c022a2">addSeqNr</a> (<a class="el" href="datatypes_8h.html#c8be006c348a522ae126f67f7b2aaf4e">sender_id_t</a> sender, <a class="el" href="datatypes_8h.html#317be74a3176b4149a817241bd69f9b2">seq_nr_t</a> seq)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSeqWindow.html#e9774163b8f7ac0ec081d1ba5b2daed2">clear</a> (<a class="el" href="datatypes_8h.html#c8be006c348a522ae126f67f7b2aaf4e">sender_id_t</a> sender)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSeqWindow.html#b1a03fe152c7c94ff3f05005d595b424">clear</a> ()</td></tr>
+
+<tr><td colspan="2"><br><h2>Private 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="classSeqWindow.html#7a30b232f312d843b8d188cae01fef28">SeqWindow</a> (const <a class="el" href="classSeqWindow.html">SeqWindow</a> &amp;s)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSeqWindow.html#37887e66297163fe301c77f2977a2a2b">operator=</a> (const <a class="el" href="classSeqWindow.html">SeqWindow</a> &amp;s)</td></tr>
+
+<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="datatypes_8h.html#0246b9fac0b861d94e0e4cc9ae2e5070">window_size_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSeqWindow.html#ef85ba28f8a655dc8c8d34aeddb8eea0">window_size_</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classMutex.html">Mutex</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSeqWindow.html#87ec44a9a7398ecbcb92d90ba95b37a0">mutex_</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classSeqWindow.html#127195f139c8d5d07ed93799c2d6821a">SenderMap</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSeqWindow.html#8bfc3742cacc75e9a72de13ff6ad98a2">sender_</a></td></tr>
+
+</table>
+<hr><h2>Member Typedef Documentation</h2>
+<a class="anchor" name="cf2d07003c8ca868146cffb4dd1d5ca7"></a><!-- doxytag: member="SeqWindow::SeqDeque" ref="cf2d07003c8ca868146cffb4dd1d5ca7" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">typedef std::deque&lt;<a class="el" href="datatypes_8h.html#317be74a3176b4149a817241bd69f9b2">seq_nr_t</a>&gt; <a class="el" href="classSeqWindow.html#cf2d07003c8ca868146cffb4dd1d5ca7">SeqWindow::SeqDeque</a>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<a class="anchor" name="127195f139c8d5d07ed93799c2d6821a"></a><!-- doxytag: member="SeqWindow::SenderMap" ref="127195f139c8d5d07ed93799c2d6821a" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">typedef std::map&lt;<a class="el" href="datatypes_8h.html#c8be006c348a522ae126f67f7b2aaf4e">sender_id_t</a>, <a class="el" href="classSeqWindow.html#cf2d07003c8ca868146cffb4dd1d5ca7">SeqDeque</a>&gt; <a class="el" href="classSeqWindow.html#127195f139c8d5d07ed93799c2d6821a">SeqWindow::SenderMap</a>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<hr><h2>Constructor &amp; Destructor Documentation</h2>
+<a class="anchor" name="8d513ab9ef2984ea93dad7e4026185c8"></a><!-- doxytag: member="SeqWindow::SeqWindow" ref="8d513ab9ef2984ea93dad7e4026185c8" args="(window_size_t w)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">SeqWindow::SeqWindow           </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="datatypes_8h.html#0246b9fac0b861d94e0e4cc9ae2e5070">window_size_t</a>&nbsp;</td>
+          <td class="paramname"> <em>w</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<a class="anchor" name="d125bcc4751a746427f04dda7fd65a10"></a><!-- doxytag: member="SeqWindow::~SeqWindow" ref="d125bcc4751a746427f04dda7fd65a10" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">SeqWindow::~SeqWindow           </td>
+          <td>(</td>
+          <td class="paramname">          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<a class="anchor" name="7a30b232f312d843b8d188cae01fef28"></a><!-- doxytag: member="SeqWindow::SeqWindow" ref="7a30b232f312d843b8d188cae01fef28" args="(const SeqWindow &amp;s)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">SeqWindow::SeqWindow           </td>
+          <td>(</td>
+          <td class="paramtype">const <a class="el" href="classSeqWindow.html">SeqWindow</a> &amp;&nbsp;</td>
+          <td class="paramname"> <em>s</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"><code> [private]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="5d39959927c79c54d133ed77b297ad7c"></a><!-- doxytag: member="SeqWindow::getLength" ref="5d39959927c79c54d133ed77b297ad7c" args="(sender_id_t sender)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">SeqWindow::SeqDeque::size_type SeqWindow::getLength           </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="datatypes_8h.html#c8be006c348a522ae126f67f7b2aaf4e">sender_id_t</a>&nbsp;</td>
+          <td class="paramname"> <em>sender</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<a class="anchor" name="9e7714dda181863420c38975bd505aff"></a><!-- doxytag: member="SeqWindow::hasSeqNr" ref="9e7714dda181863420c38975bd505aff" args="(sender_id_t sender, seq_nr_t seq)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool SeqWindow::hasSeqNr           </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="datatypes_8h.html#c8be006c348a522ae126f67f7b2aaf4e">sender_id_t</a>&nbsp;</td>
+          <td class="paramname"> <em>sender</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype"><a class="el" href="datatypes_8h.html#317be74a3176b4149a817241bd69f9b2">seq_nr_t</a>&nbsp;</td>
+          <td class="paramname"> <em>seq</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<a class="anchor" name="255ca0fca3e701bd9e18d9fcb2c022a2"></a><!-- doxytag: member="SeqWindow::addSeqNr" ref="255ca0fca3e701bd9e18d9fcb2c022a2" args="(sender_id_t sender, seq_nr_t seq)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void SeqWindow::addSeqNr           </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="datatypes_8h.html#c8be006c348a522ae126f67f7b2aaf4e">sender_id_t</a>&nbsp;</td>
+          <td class="paramname"> <em>sender</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype"><a class="el" href="datatypes_8h.html#317be74a3176b4149a817241bd69f9b2">seq_nr_t</a>&nbsp;</td>
+          <td class="paramname"> <em>seq</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<a class="anchor" name="e9774163b8f7ac0ec081d1ba5b2daed2"></a><!-- doxytag: member="SeqWindow::clear" ref="e9774163b8f7ac0ec081d1ba5b2daed2" args="(sender_id_t sender)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void SeqWindow::clear           </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="datatypes_8h.html#c8be006c348a522ae126f67f7b2aaf4e">sender_id_t</a>&nbsp;</td>
+          <td class="paramname"> <em>sender</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<a class="anchor" name="b1a03fe152c7c94ff3f05005d595b424"></a><!-- doxytag: member="SeqWindow::clear" ref="b1a03fe152c7c94ff3f05005d595b424" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void SeqWindow::clear           </td>
+          <td>(</td>
+          <td class="paramname">          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<a class="anchor" name="37887e66297163fe301c77f2977a2a2b"></a><!-- doxytag: member="SeqWindow::operator=" ref="37887e66297163fe301c77f2977a2a2b" args="(const SeqWindow &amp;s)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void SeqWindow::operator=           </td>
+          <td>(</td>
+          <td class="paramtype">const <a class="el" href="classSeqWindow.html">SeqWindow</a> &amp;&nbsp;</td>
+          <td class="paramname"> <em>s</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"><code> [private]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<hr><h2>Member Data Documentation</h2>
+<a class="anchor" name="ef85ba28f8a655dc8c8d34aeddb8eea0"></a><!-- doxytag: member="SeqWindow::window_size_" ref="ef85ba28f8a655dc8c8d34aeddb8eea0" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="datatypes_8h.html#0246b9fac0b861d94e0e4cc9ae2e5070">window_size_t</a> <a class="el" href="classSeqWindow.html#ef85ba28f8a655dc8c8d34aeddb8eea0">SeqWindow::window_size_</a><code> [private]</code>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<a class="anchor" name="87ec44a9a7398ecbcb92d90ba95b37a0"></a><!-- doxytag: member="SeqWindow::mutex_" ref="87ec44a9a7398ecbcb92d90ba95b37a0" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="classMutex.html">Mutex</a> <a class="el" href="classSeqWindow.html#87ec44a9a7398ecbcb92d90ba95b37a0">SeqWindow::mutex_</a><code> [private]</code>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<a class="anchor" name="8bfc3742cacc75e9a72de13ff6ad98a2"></a><!-- doxytag: member="SeqWindow::sender_" ref="8bfc3742cacc75e9a72de13ff6ad98a2" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="classSeqWindow.html#127195f139c8d5d07ed93799c2d6821a">SenderMap</a> <a class="el" href="classSeqWindow.html#8bfc3742cacc75e9a72de13ff6ad98a2">SeqWindow::sender_</a><code> [private]</code>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<hr>The documentation for this class was generated from the following files:<ul>
+<li><a class="el" href="seqWindow_8h-source.html">seqWindow.h</a><li><a class="el" href="seqWindow_8cpp.html">seqWindow.cpp</a></ul>
+<hr size="1"><address style="align: right;"><small>Generated on Sun Oct 7 23:43:50 2007 for anytun by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
+</body>
+</html>
author	Erwin Nindl <nine@wirdorange.org>	2007-10-07 22:07:03 +0000
committer	Erwin Nindl <nine@wirdorange.org>	2007-10-07 22:07:03 +0000
commit	7763f07327f3abce839a690df46ced3bfd1d3d09 (patch)
tree	c80abe2cf8e137edba89cad9f14f63048275cee1 /doc/html/classSeqWindow.html
parent	added doxygen, and doxygen makefile target (diff)