root/doc/html/classitpp_1_1TCP__Segment.html @ 353

Revision 353, 14.5 kB (checked in by smidl, 16 years ago)

doc

RevLine 
[353]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>mixpp: itpp::TCP_Segment Class Reference</title>
4<link href="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.8 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li><a href="modules.html"><span>Modules</span></a></li>
55      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
56      <li><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
62      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
63      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
64      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
65    </ul>
66  </div>
67  <div class="navpath"><b>itpp</b>::<a class="el" href="classitpp_1_1TCP__Segment.html">TCP_Segment</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::TCP_Segment Class Reference<br>
72<small>
73[<a class="el" href="group__protocol.html">Protocols Module</a>]</small>
74</h1><!-- doxytag: class="itpp::TCP_Segment" --><code>#include &lt;<a class="el" href="tcp_8h-source.html">tcp.h</a>&gt;</code>
75<p>
76
77<p>
78<a href="classitpp_1_1TCP__Segment-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
79<tr><td></td></tr>
80<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ca21e0ca2d17d993f07126bdce7c3903"></a><!-- doxytag: member="itpp::TCP_Segment::TCP_Segment" ref="ca21e0ca2d17d993f07126bdce7c3903" args="()" -->
82&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1TCP__Segment.html#ca21e0ca2d17d993f07126bdce7c3903">TCP_Segment</a> ()</td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="854bd49376215adb33223810f472946e"></a><!-- doxytag: member="itpp::TCP_Segment::TCP_Segment" ref="854bd49376215adb33223810f472946e" args="(const Sequence_Number &amp;sn_begin, const Sequence_Number &amp;sn_end)" -->
86&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1TCP__Segment.html#854bd49376215adb33223810f472946e">TCP_Segment</a> (const <a class="el" href="classitpp_1_1Sequence__Number.html">Sequence_Number</a> &amp;sn_begin, const <a class="el" href="classitpp_1_1Sequence__Number.html">Sequence_Number</a> &amp;sn_end)</td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6803a95691b07e41551e62b8f7fad5d5"></a><!-- doxytag: member="itpp::TCP_Segment::TCP_Segment" ref="6803a95691b07e41551e62b8f7fad5d5" args="(const TCP_Segment &amp;segment)" -->
90&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1TCP__Segment.html#6803a95691b07e41551e62b8f7fad5d5">TCP_Segment</a> (const <a class="el" href="classitpp_1_1TCP__Segment.html">TCP_Segment</a> &amp;segment)</td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="549fbf13c3ca7c009da9fefa3bd38054"></a><!-- doxytag: member="itpp::TCP_Segment::operator=" ref="549fbf13c3ca7c009da9fefa3bd38054" args="(const TCP_Segment &amp;segment)" -->
94<a class="el" href="classitpp_1_1TCP__Segment.html">TCP_Segment</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1TCP__Segment.html#549fbf13c3ca7c009da9fefa3bd38054">operator=</a> (const <a class="el" href="classitpp_1_1TCP__Segment.html">TCP_Segment</a> &amp;segment)</td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gdf1e7e6fc51aab68c7c8fa571bf00edd"></a><!-- doxytag: member="itpp::TCP_Segment::set_begin" ref="gdf1e7e6fc51aab68c7c8fa571bf00edd" args="(const Sequence_Number &amp;sn)" -->
98void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__protocol.html#gdf1e7e6fc51aab68c7c8fa571bf00edd">set_begin</a> (const <a class="el" href="classitpp_1_1Sequence__Number.html">Sequence_Number</a> &amp;sn)</td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gcc81e83b9a513142363f6388b1abf9c6"></a><!-- doxytag: member="itpp::TCP_Segment::set_end" ref="gcc81e83b9a513142363f6388b1abf9c6" args="(const Sequence_Number &amp;sn)" -->
102void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__protocol.html#gcc81e83b9a513142363f6388b1abf9c6">set_end</a> (const <a class="el" href="classitpp_1_1Sequence__Number.html">Sequence_Number</a> &amp;sn)</td></tr>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7e7f318913d188634a26389102ff66cb"></a><!-- doxytag: member="itpp::TCP_Segment::combine" ref="7e7f318913d188634a26389102ff66cb" args="(const TCP_Segment &amp;segment)" -->
106void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1TCP__Segment.html#7e7f318913d188634a26389102ff66cb">combine</a> (const <a class="el" href="classitpp_1_1TCP__Segment.html">TCP_Segment</a> &amp;segment)</td></tr>
107
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
109<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g621cc3bc951211d85ea9d01dd0a242e1"></a><!-- doxytag: member="itpp::TCP_Segment::operator==" ref="g621cc3bc951211d85ea9d01dd0a242e1" args="(const TCP_Segment &amp;segment) const " -->
110bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__protocol.html#g621cc3bc951211d85ea9d01dd0a242e1">operator==</a> (const <a class="el" href="classitpp_1_1TCP__Segment.html">TCP_Segment</a> &amp;segment) const </td></tr>
111
112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
113<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g250e7dff8c2620d37e0181f9145675f0"></a><!-- doxytag: member="itpp::TCP_Segment::operator!=" ref="g250e7dff8c2620d37e0181f9145675f0" args="(const TCP_Segment &amp;segment) const " -->
114bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__protocol.html#g250e7dff8c2620d37e0181f9145675f0">operator!=</a> (const <a class="el" href="classitpp_1_1TCP__Segment.html">TCP_Segment</a> &amp;segment) const </td></tr>
115
116<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
117<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g1dea82fb7b04634cff8e01afa45881f0"></a><!-- doxytag: member="itpp::TCP_Segment::can_be_combined" ref="g1dea82fb7b04634cff8e01afa45881f0" args="(const TCP_Segment &amp;segment) const " -->
118bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__protocol.html#g1dea82fb7b04634cff8e01afa45881f0">can_be_combined</a> (const <a class="el" href="classitpp_1_1TCP__Segment.html">TCP_Segment</a> &amp;segment) const </td></tr>
119
120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
121<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="geffe232b6370e7d57ec9b28045f83168"></a><!-- doxytag: member="itpp::TCP_Segment::is_contained" ref="geffe232b6370e7d57ec9b28045f83168" args="(const TCP_Segment &amp;segment) const " -->
122bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__protocol.html#geffe232b6370e7d57ec9b28045f83168">is_contained</a> (const <a class="el" href="classitpp_1_1TCP__Segment.html">TCP_Segment</a> &amp;segment) const </td></tr>
123
124<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
125<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga582b8271e033fdead7e875e8872936c"></a><!-- doxytag: member="itpp::TCP_Segment::length" ref="ga582b8271e033fdead7e875e8872936c" args="() const " -->
126unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__protocol.html#ga582b8271e033fdead7e875e8872936c">length</a> () const </td></tr>
127
128<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
129<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="656bd8f6c297e86df8b6060590f164a5"></a><!-- doxytag: member="itpp::TCP_Segment::begin" ref="656bd8f6c297e86df8b6060590f164a5" args="() const " -->
130<a class="el" href="classitpp_1_1Sequence__Number.html">Sequence_Number</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1TCP__Segment.html#656bd8f6c297e86df8b6060590f164a5">begin</a> () const </td></tr>
131
132<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
133<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ddbd28a0830ed97af204c28322731be3"></a><!-- doxytag: member="itpp::TCP_Segment::end" ref="ddbd28a0830ed97af204c28322731be3" args="() const " -->
134<a class="el" href="classitpp_1_1Sequence__Number.html">Sequence_Number</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1TCP__Segment.html#ddbd28a0830ed97af204c28322731be3">end</a> () const </td></tr>
135
136<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
137<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
138<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="682a833137dd7e66d7f6cc349b5a9778"></a><!-- doxytag: member="itpp::TCP_Segment::seq_begin" ref="682a833137dd7e66d7f6cc349b5a9778" args="" -->
139<a class="el" href="classitpp_1_1Sequence__Number.html">Sequence_Number</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1TCP__Segment.html#682a833137dd7e66d7f6cc349b5a9778">seq_begin</a></td></tr>
140
141<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">no. of first byte of segment <br></td></tr>
142<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="31aba03e7100bca14eb4b4f61aa58974"></a><!-- doxytag: member="itpp::TCP_Segment::seq_end" ref="31aba03e7100bca14eb4b4f61aa58974" args="" -->
143<a class="el" href="classitpp_1_1Sequence__Number.html">Sequence_Number</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1TCP__Segment.html#31aba03e7100bca14eb4b4f61aa58974">seq_end</a></td></tr>
144
145<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">no. of last byte of segment + 1 <br></td></tr>
146<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
147<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="22c1b8913ce9662f7ded6a242166cbce"></a><!-- doxytag: member="itpp::TCP_Segment::operator&lt;&lt;" ref="22c1b8913ce9662f7ded6a242166cbce" args="(std::ostream &amp;os, const TCP_Segment &amp;segment)" -->
148std::ostream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1TCP__Segment.html#22c1b8913ce9662f7ded6a242166cbce">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="classitpp_1_1TCP__Segment.html">TCP_Segment</a> &amp;segment)</td></tr>
149
150<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
151</table>
152<hr><a name="_details"></a><h2>Detailed Description</h2>
153TCP is a byte oriented protcol. Parts of the byte stream that is transmitted are called segments. They are identified by sequence numbers <a class="el" href="classitpp_1_1TCP__Segment.html">TCP_Segment</a> contains fileds for the beginning sequence number and the sequence number of the first byte in the following segment (i.e. the sequence number of the last byte + 1). <a class="el" href="classitpp_1_1TCP__Segment.html">TCP_Segment</a> provides several const methods to compare segments and to check whether they overlap. <a class="el" href="classitpp_1_1TCP__Segment.html">TCP_Segment</a> is, e.g., used in TTCPPacket and TTCPReceiverBuffer.<p>
154<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classitpp_1_1Sequence__Number.html">Sequence_Number</a> <p>
155TTCPPacket <p>
156TTCPReceiverBuffer </dd></dl>
157<dl class="author" compact><dt><b>Author:</b></dt><dd>Lorang <p>
158Bodamer </dd></dl>
159<hr>The documentation for this class was generated from the following file:<ul>
160<li><a class="el" href="tcp_8h-source.html">tcp.h</a></ul>
161</div>
162<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
163<a href="http://www.doxygen.org/index.html">
164<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
165</body>
166</html>
Note: See TracBrowser for help on using the browser.