Adding Javadoc documentation.
[pingpong.git] / Code / Projects / PacketLevelSignatureExtractor / javadoc / edu / uci / iotproject / trafficreassembly / layer2 / Layer2FlowReassembler.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>Layer2FlowReassembler</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="Layer2FlowReassembler";
16         }
17     }
18     catch(err) {
19     }
20 //-->
21 var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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/layer2/Layer2FlowObserver.html" title="interface in edu.uci.iotproject.trafficreassembly.layer2"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
52 <li><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2FlowReassemblerObserver.html" title="interface in edu.uci.iotproject.trafficreassembly.layer2"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
53 </ul>
54 <ul class="navList">
55 <li><a href="../../../../../index.html?edu/uci/iotproject/trafficreassembly/layer2/Layer2FlowReassembler.html" target="_top">Frames</a></li>
56 <li><a href="Layer2FlowReassembler.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.layer2</div>
95 <h2 title="Class Layer2FlowReassembler" class="title">Class Layer2FlowReassembler</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.layer2.Layer2FlowReassembler</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">Layer2FlowReassembler</span>
116 extends java.lang.Object
117 implements org.pcap4j.core.PacketListener</pre>
118 <div class="block">Reassembles traffic flows at layer 2, i.e., for each combination of hosts, creates a list of packets exchanged
119  between said hosts.</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/layer2/Layer2FlowReassembler.html#Layer2FlowReassembler--">Layer2FlowReassembler</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>void</code></td>
157 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2FlowReassembler.html#addObserver-edu.uci.iotproject.trafficreassembly.layer2.Layer2FlowReassemblerObserver-">addObserver</a></span>(<a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2FlowReassemblerObserver.html" title="interface in edu.uci.iotproject.trafficreassembly.layer2">Layer2FlowReassemblerObserver</a>&nbsp;observer)</code>&nbsp;</td>
158 </tr>
159 <tr id="i1" class="rowColor">
160 <td class="colFirst"><code><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2Flow.html" title="class in edu.uci.iotproject.trafficreassembly.layer2">Layer2Flow</a></code></td>
161 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2FlowReassembler.html#getFlowForAddresses-org.pcap4j.util.MacAddress-org.pcap4j.util.MacAddress-">getFlowForAddresses</a></span>(org.pcap4j.util.MacAddress&nbsp;addr1,
162                    org.pcap4j.util.MacAddress&nbsp;addr2)</code>
163 <div class="block">Get the traffic flow between two local endpoints (<code>MacAddress</code>es).</div>
164 </td>
165 </tr>
166 <tr id="i2" class="altColor">
167 <td class="colFirst"><code>java.util.Collection&lt;<a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2Flow.html" title="class in edu.uci.iotproject.trafficreassembly.layer2">Layer2Flow</a>&gt;</code></td>
168 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2FlowReassembler.html#getFlows--">getFlows</a></span>()</code>
169 <div class="block">Get all traffic flows, i.e., a traffic flow for each unique pair of endpoints (MAC addresses).</div>
170 </td>
171 </tr>
172 <tr id="i3" class="rowColor">
173 <td class="colFirst"><code>void</code></td>
174 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2FlowReassembler.html#gotPacket-org.pcap4j.core.PcapPacket-">gotPacket</a></span>(org.pcap4j.core.PcapPacket&nbsp;packet)</code>&nbsp;</td>
175 </tr>
176 <tr id="i4" class="altColor">
177 <td class="colFirst"><code>void</code></td>
178 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2FlowReassembler.html#removeObserver-edu.uci.iotproject.trafficreassembly.layer2.Layer2FlowReassemblerObserver-">removeObserver</a></span>(<a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2FlowReassemblerObserver.html" title="interface in edu.uci.iotproject.trafficreassembly.layer2">Layer2FlowReassemblerObserver</a>&nbsp;observer)</code>&nbsp;</td>
179 </tr>
180 </table>
181 <ul class="blockList">
182 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
183 <!--   -->
184 </a>
185 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
186 <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
187 </ul>
188 </li>
189 </ul>
190 </li>
191 </ul>
192 </div>
193 <div class="details">
194 <ul class="blockList">
195 <li class="blockList">
196 <!-- ========= CONSTRUCTOR DETAIL ======== -->
197 <ul class="blockList">
198 <li class="blockList"><a name="constructor.detail">
199 <!--   -->
200 </a>
201 <h3>Constructor Detail</h3>
202 <a name="Layer2FlowReassembler--">
203 <!--   -->
204 </a>
205 <ul class="blockListLast">
206 <li class="blockList">
207 <h4>Layer2FlowReassembler</h4>
208 <pre>public&nbsp;Layer2FlowReassembler()</pre>
209 </li>
210 </ul>
211 </li>
212 </ul>
213 <!-- ============ METHOD DETAIL ========== -->
214 <ul class="blockList">
215 <li class="blockList"><a name="method.detail">
216 <!--   -->
217 </a>
218 <h3>Method Detail</h3>
219 <a name="gotPacket-org.pcap4j.core.PcapPacket-">
220 <!--   -->
221 </a>
222 <ul class="blockList">
223 <li class="blockList">
224 <h4>gotPacket</h4>
225 <pre>public&nbsp;void&nbsp;gotPacket(org.pcap4j.core.PcapPacket&nbsp;packet)</pre>
226 <dl>
227 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
228 <dd><code>gotPacket</code>&nbsp;in interface&nbsp;<code>org.pcap4j.core.PacketListener</code></dd>
229 </dl>
230 </li>
231 </ul>
232 <a name="addObserver-edu.uci.iotproject.trafficreassembly.layer2.Layer2FlowReassemblerObserver-">
233 <!--   -->
234 </a>
235 <ul class="blockList">
236 <li class="blockList">
237 <h4>addObserver</h4>
238 <pre>public&nbsp;void&nbsp;addObserver(<a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2FlowReassemblerObserver.html" title="interface in edu.uci.iotproject.trafficreassembly.layer2">Layer2FlowReassemblerObserver</a>&nbsp;observer)</pre>
239 </li>
240 </ul>
241 <a name="removeObserver-edu.uci.iotproject.trafficreassembly.layer2.Layer2FlowReassemblerObserver-">
242 <!--   -->
243 </a>
244 <ul class="blockList">
245 <li class="blockList">
246 <h4>removeObserver</h4>
247 <pre>public&nbsp;void&nbsp;removeObserver(<a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2FlowReassemblerObserver.html" title="interface in edu.uci.iotproject.trafficreassembly.layer2">Layer2FlowReassemblerObserver</a>&nbsp;observer)</pre>
248 </li>
249 </ul>
250 <a name="getFlowForAddresses-org.pcap4j.util.MacAddress-org.pcap4j.util.MacAddress-">
251 <!--   -->
252 </a>
253 <ul class="blockList">
254 <li class="blockList">
255 <h4>getFlowForAddresses</h4>
256 <pre>public&nbsp;<a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2Flow.html" title="class in edu.uci.iotproject.trafficreassembly.layer2">Layer2Flow</a>&nbsp;getFlowForAddresses(org.pcap4j.util.MacAddress&nbsp;addr1,
257                                       org.pcap4j.util.MacAddress&nbsp;addr2)</pre>
258 <div class="block">Get the traffic flow between two local endpoints (<code>MacAddress</code>es).</div>
259 <dl>
260 <dt><span class="paramLabel">Parameters:</span></dt>
261 <dd><code>addr1</code> - The first endpoint.</dd>
262 <dd><code>addr2</code> - The second endpoint</dd>
263 <dt><span class="returnLabel">Returns:</span></dt>
264 <dd>The traffic exchanged between the two endpoints.</dd>
265 </dl>
266 </li>
267 </ul>
268 <a name="getFlows--">
269 <!--   -->
270 </a>
271 <ul class="blockListLast">
272 <li class="blockList">
273 <h4>getFlows</h4>
274 <pre>public&nbsp;java.util.Collection&lt;<a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2Flow.html" title="class in edu.uci.iotproject.trafficreassembly.layer2">Layer2Flow</a>&gt;&nbsp;getFlows()</pre>
275 <div class="block">Get all traffic flows, i.e., a traffic flow for each unique pair of endpoints (MAC addresses).</div>
276 <dl>
277 <dt><span class="returnLabel">Returns:</span></dt>
278 <dd>All traffic flows.</dd>
279 </dl>
280 </li>
281 </ul>
282 </li>
283 </ul>
284 </li>
285 </ul>
286 </div>
287 </div>
288 <!-- ========= END OF CLASS DATA ========= -->
289 <!-- ======= START OF BOTTOM NAVBAR ====== -->
290 <div class="bottomNav"><a name="navbar.bottom">
291 <!--   -->
292 </a>
293 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
294 <a name="navbar.bottom.firstrow">
295 <!--   -->
296 </a>
297 <ul class="navList" title="Navigation">
298 <li><a href="../../../../../overview-summary.html">Overview</a></li>
299 <li><a href="package-summary.html">Package</a></li>
300 <li class="navBarCell1Rev">Class</li>
301 <li><a href="package-tree.html">Tree</a></li>
302 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
303 <li><a href="../../../../../index-files/index-1.html">Index</a></li>
304 <li><a href="../../../../../help-doc.html">Help</a></li>
305 </ul>
306 </div>
307 <div class="subNav">
308 <ul class="navList">
309 <li><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2FlowObserver.html" title="interface in edu.uci.iotproject.trafficreassembly.layer2"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
310 <li><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2FlowReassemblerObserver.html" title="interface in edu.uci.iotproject.trafficreassembly.layer2"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
311 </ul>
312 <ul class="navList">
313 <li><a href="../../../../../index.html?edu/uci/iotproject/trafficreassembly/layer2/Layer2FlowReassembler.html" target="_top">Frames</a></li>
314 <li><a href="Layer2FlowReassembler.html" target="_top">No&nbsp;Frames</a></li>
315 </ul>
316 <ul class="navList" id="allclasses_navbar_bottom">
317 <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
318 </ul>
319 <div>
320 <script type="text/javascript"><!--
321   allClassesLink = document.getElementById("allclasses_navbar_bottom");
322   if(window==top) {
323     allClassesLink.style.display = "block";
324   }
325   else {
326     allClassesLink.style.display = "none";
327   }
328   //-->
329 </script>
330 </div>
331 <div>
332 <ul class="subNavList">
333 <li>Summary:&nbsp;</li>
334 <li>Nested&nbsp;|&nbsp;</li>
335 <li>Field&nbsp;|&nbsp;</li>
336 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
337 <li><a href="#method.summary">Method</a></li>
338 </ul>
339 <ul class="subNavList">
340 <li>Detail:&nbsp;</li>
341 <li>Field&nbsp;|&nbsp;</li>
342 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
343 <li><a href="#method.detail">Method</a></li>
344 </ul>
345 </div>
346 <a name="skip.navbar.bottom">
347 <!--   -->
348 </a></div>
349 <!-- ======== END OF BOTTOM NAVBAR ======= -->
350 </body>
351 </html>