Adding Javadoc documentation.
[pingpong.git] / Code / Projects / PacketLevelSignatureExtractor / javadoc / edu / uci / iotproject / trafficreassembly / layer3 / TcpReassembler.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!-- NewPage -->
3 <html lang="en">
4 <head>
5 <!-- Generated by javadoc (1.8.0_191) on Thu Mar 28 11:26:58 PDT 2019 -->
6 <title>TcpReassembler</title>
7 <meta name="date" content="2019-03-28">
8 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
9 <script type="text/javascript" src="../../../../../script.js"></script>
10 </head>
11 <body>
12 <script type="text/javascript"><!--
13     try {
14         if (location.href.indexOf('is-external=true') == -1) {
15             parent.document.title="TcpReassembler";
16         }
17     }
18     catch(err) {
19     }
20 //-->
21 var methods = {"i0":10,"i1":10};
22 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
23 var altColor = "altColor";
24 var rowColor = "rowColor";
25 var tableTab = "tableTab";
26 var activeTableTab = "activeTableTab";
27 </script>
28 <noscript>
29 <div>JavaScript is disabled on your browser.</div>
30 </noscript>
31 <!-- ========= START OF TOP NAVBAR ======= -->
32 <div class="topNav"><a name="navbar.top">
33 <!--   -->
34 </a>
35 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
36 <a name="navbar.top.firstrow">
37 <!--   -->
38 </a>
39 <ul class="navList" title="Navigation">
40 <li><a href="../../../../../overview-summary.html">Overview</a></li>
41 <li><a href="package-summary.html">Package</a></li>
42 <li class="navBarCell1Rev">Class</li>
43 <li><a href="package-tree.html">Tree</a></li>
44 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
45 <li><a href="../../../../../index-files/index-1.html">Index</a></li>
46 <li><a href="../../../../../help-doc.html">Help</a></li>
47 </ul>
48 </div>
49 <div class="subNav">
50 <ul class="navList">
51 <li><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/FinAckPair.html" title="class in edu.uci.iotproject.trafficreassembly.layer3"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
52 <li>Next&nbsp;Class</li>
53 </ul>
54 <ul class="navList">
55 <li><a href="../../../../../index.html?edu/uci/iotproject/trafficreassembly/layer3/TcpReassembler.html" target="_top">Frames</a></li>
56 <li><a href="TcpReassembler.html" target="_top">No&nbsp;Frames</a></li>
57 </ul>
58 <ul class="navList" id="allclasses_navbar_top">
59 <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
60 </ul>
61 <div>
62 <script type="text/javascript"><!--
63   allClassesLink = document.getElementById("allclasses_navbar_top");
64   if(window==top) {
65     allClassesLink.style.display = "block";
66   }
67   else {
68     allClassesLink.style.display = "none";
69   }
70   //-->
71 </script>
72 </div>
73 <div>
74 <ul class="subNavList">
75 <li>Summary:&nbsp;</li>
76 <li>Nested&nbsp;|&nbsp;</li>
77 <li>Field&nbsp;|&nbsp;</li>
78 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
79 <li><a href="#method.summary">Method</a></li>
80 </ul>
81 <ul class="subNavList">
82 <li>Detail:&nbsp;</li>
83 <li>Field&nbsp;|&nbsp;</li>
84 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
85 <li><a href="#method.detail">Method</a></li>
86 </ul>
87 </div>
88 <a name="skip.navbar.top">
89 <!--   -->
90 </a></div>
91 <!-- ========= END OF TOP NAVBAR ========= -->
92 <!-- ======== START OF CLASS DATA ======== -->
93 <div class="header">
94 <div class="subTitle">edu.uci.iotproject.trafficreassembly.layer3</div>
95 <h2 title="Class TcpReassembler" class="title">Class TcpReassembler</h2>
96 </div>
97 <div class="contentContainer">
98 <ul class="inheritance">
99 <li>java.lang.Object</li>
100 <li>
101 <ul class="inheritance">
102 <li>edu.uci.iotproject.trafficreassembly.layer3.TcpReassembler</li>
103 </ul>
104 </li>
105 </ul>
106 <div class="description">
107 <ul class="blockList">
108 <li class="blockList">
109 <dl>
110 <dt>All Implemented Interfaces:</dt>
111 <dd>org.pcap4j.core.PacketListener</dd>
112 </dl>
113 <hr>
114 <br>
115 <pre>public class <span class="typeNameLabel">TcpReassembler</span>
116 extends java.lang.Object
117 implements org.pcap4j.core.PacketListener</pre>
118 <div class="block">Reassembles TCP conversations (streams).
119  <b>Note: current version only supports TCP over IPv4.</b></div>
120 </li>
121 </ul>
122 </div>
123 <div class="summary">
124 <ul class="blockList">
125 <li class="blockList">
126 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
127 <ul class="blockList">
128 <li class="blockList"><a name="constructor.summary">
129 <!--   -->
130 </a>
131 <h3>Constructor Summary</h3>
132 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
133 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
134 <tr>
135 <th class="colOne" scope="col">Constructor and Description</th>
136 </tr>
137 <tr class="altColor">
138 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/TcpReassembler.html#TcpReassembler--">TcpReassembler</a></span>()</code>&nbsp;</td>
139 </tr>
140 </table>
141 </li>
142 </ul>
143 <!-- ========== METHOD SUMMARY =========== -->
144 <ul class="blockList">
145 <li class="blockList"><a name="method.summary">
146 <!--   -->
147 </a>
148 <h3>Method Summary</h3>
149 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
150 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
151 <tr>
152 <th class="colFirst" scope="col">Modifier and Type</th>
153 <th class="colLast" scope="col">Method and Description</th>
154 </tr>
155 <tr id="i0" class="altColor">
156 <td class="colFirst"><code>java.util.List&lt;<a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/Conversation.html" title="class in edu.uci.iotproject.trafficreassembly.layer3">Conversation</a>&gt;</code></td>
157 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/TcpReassembler.html#getTcpConversations--">getTcpConversations</a></span>()</code>
158 <div class="block">Get the reassembled TCP connections.</div>
159 </td>
160 </tr>
161 <tr id="i1" class="rowColor">
162 <td class="colFirst"><code>void</code></td>
163 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/TcpReassembler.html#gotPacket-org.pcap4j.core.PcapPacket-">gotPacket</a></span>(org.pcap4j.core.PcapPacket&nbsp;pcapPacket)</code>&nbsp;</td>
164 </tr>
165 </table>
166 <ul class="blockList">
167 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
168 <!--   -->
169 </a>
170 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
171 <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
172 </ul>
173 </li>
174 </ul>
175 </li>
176 </ul>
177 </div>
178 <div class="details">
179 <ul class="blockList">
180 <li class="blockList">
181 <!-- ========= CONSTRUCTOR DETAIL ======== -->
182 <ul class="blockList">
183 <li class="blockList"><a name="constructor.detail">
184 <!--   -->
185 </a>
186 <h3>Constructor Detail</h3>
187 <a name="TcpReassembler--">
188 <!--   -->
189 </a>
190 <ul class="blockListLast">
191 <li class="blockList">
192 <h4>TcpReassembler</h4>
193 <pre>public&nbsp;TcpReassembler()</pre>
194 </li>
195 </ul>
196 </li>
197 </ul>
198 <!-- ============ METHOD DETAIL ========== -->
199 <ul class="blockList">
200 <li class="blockList"><a name="method.detail">
201 <!--   -->
202 </a>
203 <h3>Method Detail</h3>
204 <a name="gotPacket-org.pcap4j.core.PcapPacket-">
205 <!--   -->
206 </a>
207 <ul class="blockList">
208 <li class="blockList">
209 <h4>gotPacket</h4>
210 <pre>public&nbsp;void&nbsp;gotPacket(org.pcap4j.core.PcapPacket&nbsp;pcapPacket)</pre>
211 <dl>
212 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
213 <dd><code>gotPacket</code>&nbsp;in interface&nbsp;<code>org.pcap4j.core.PacketListener</code></dd>
214 </dl>
215 </li>
216 </ul>
217 <a name="getTcpConversations--">
218 <!--   -->
219 </a>
220 <ul class="blockListLast">
221 <li class="blockList">
222 <h4>getTcpConversations</h4>
223 <pre>public&nbsp;java.util.List&lt;<a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/Conversation.html" title="class in edu.uci.iotproject.trafficreassembly.layer3">Conversation</a>&gt;&nbsp;getTcpConversations()</pre>
224 <div class="block">Get the reassembled TCP connections. Note that if this is called while packets are still being processed (by
225  calls to <a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/TcpReassembler.html#gotPacket-org.pcap4j.core.PcapPacket-"><code>gotPacket(PcapPacket)</code></a>), the behavior is undefined and the returned list may be inconsistent.</div>
226 <dl>
227 <dt><span class="returnLabel">Returns:</span></dt>
228 <dd>The reassembled TCP connections.</dd>
229 </dl>
230 </li>
231 </ul>
232 </li>
233 </ul>
234 </li>
235 </ul>
236 </div>
237 </div>
238 <!-- ========= END OF CLASS DATA ========= -->
239 <!-- ======= START OF BOTTOM NAVBAR ====== -->
240 <div class="bottomNav"><a name="navbar.bottom">
241 <!--   -->
242 </a>
243 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
244 <a name="navbar.bottom.firstrow">
245 <!--   -->
246 </a>
247 <ul class="navList" title="Navigation">
248 <li><a href="../../../../../overview-summary.html">Overview</a></li>
249 <li><a href="package-summary.html">Package</a></li>
250 <li class="navBarCell1Rev">Class</li>
251 <li><a href="package-tree.html">Tree</a></li>
252 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
253 <li><a href="../../../../../index-files/index-1.html">Index</a></li>
254 <li><a href="../../../../../help-doc.html">Help</a></li>
255 </ul>
256 </div>
257 <div class="subNav">
258 <ul class="navList">
259 <li><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/FinAckPair.html" title="class in edu.uci.iotproject.trafficreassembly.layer3"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
260 <li>Next&nbsp;Class</li>
261 </ul>
262 <ul class="navList">
263 <li><a href="../../../../../index.html?edu/uci/iotproject/trafficreassembly/layer3/TcpReassembler.html" target="_top">Frames</a></li>
264 <li><a href="TcpReassembler.html" target="_top">No&nbsp;Frames</a></li>
265 </ul>
266 <ul class="navList" id="allclasses_navbar_bottom">
267 <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
268 </ul>
269 <div>
270 <script type="text/javascript"><!--
271   allClassesLink = document.getElementById("allclasses_navbar_bottom");
272   if(window==top) {
273     allClassesLink.style.display = "block";
274   }
275   else {
276     allClassesLink.style.display = "none";
277   }
278   //-->
279 </script>
280 </div>
281 <div>
282 <ul class="subNavList">
283 <li>Summary:&nbsp;</li>
284 <li>Nested&nbsp;|&nbsp;</li>
285 <li>Field&nbsp;|&nbsp;</li>
286 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
287 <li><a href="#method.summary">Method</a></li>
288 </ul>
289 <ul class="subNavList">
290 <li>Detail:&nbsp;</li>
291 <li>Field&nbsp;|&nbsp;</li>
292 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
293 <li><a href="#method.detail">Method</a></li>
294 </ul>
295 </div>
296 <a name="skip.navbar.bottom">
297 <!--   -->
298 </a></div>
299 <!-- ======== END OF BOTTOM NAVBAR ======= -->
300 </body>
301 </html>