1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
5 <!-- Generated by javadoc (1.8.0_191) on Thu Mar 28 11:26:58 PDT 2019 -->
6 <title>Layer2Flow</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>
12 <script type="text/javascript"><!--
14 if (location.href.indexOf('is-external=true') == -1) {
15 parent.document.title="Layer2Flow";
21 var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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";
29 <div>JavaScript is disabled on your browser.</div>
31 <!-- ========= START OF TOP NAVBAR ======= -->
32 <div class="topNav"><a name="navbar.top">
35 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
36 <a name="navbar.top.firstrow">
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>
51 <li>Prev Class</li>
52 <li><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2FlowObserver.html" title="interface in edu.uci.iotproject.trafficreassembly.layer2"><span class="typeNameLink">Next Class</span></a></li>
55 <li><a href="../../../../../index.html?edu/uci/iotproject/trafficreassembly/layer2/Layer2Flow.html" target="_top">Frames</a></li>
56 <li><a href="Layer2Flow.html" target="_top">No Frames</a></li>
58 <ul class="navList" id="allclasses_navbar_top">
59 <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
62 <script type="text/javascript"><!--
63 allClassesLink = document.getElementById("allclasses_navbar_top");
65 allClassesLink.style.display = "block";
68 allClassesLink.style.display = "none";
74 <ul class="subNavList">
75 <li>Summary: </li>
76 <li>Nested | </li>
77 <li>Field | </li>
78 <li><a href="#constructor.summary">Constr</a> | </li>
79 <li><a href="#method.summary">Method</a></li>
81 <ul class="subNavList">
82 <li>Detail: </li>
83 <li>Field | </li>
84 <li><a href="#constructor.detail">Constr</a> | </li>
85 <li><a href="#method.detail">Method</a></li>
88 <a name="skip.navbar.top">
91 <!-- ========= END OF TOP NAVBAR ========= -->
92 <!-- ======== START OF CLASS DATA ======== -->
94 <div class="subTitle">edu.uci.iotproject.trafficreassembly.layer2</div>
95 <h2 title="Class Layer2Flow" class="title">Class Layer2Flow</h2>
97 <div class="contentContainer">
98 <ul class="inheritance">
99 <li>java.lang.Object</li>
101 <ul class="inheritance">
102 <li>edu.uci.iotproject.trafficreassembly.layer2.Layer2Flow</li>
106 <div class="description">
107 <ul class="blockList">
108 <li class="blockList">
111 <pre>public class <span class="typeNameLabel">Layer2Flow</span>
112 extends java.lang.Object</pre>
113 <div class="block">Models a layer 2 flow: groups packets exchanged between two specific endpoints (MAC addresses).</div>
117 <div class="summary">
118 <ul class="blockList">
119 <li class="blockList">
120 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
121 <ul class="blockList">
122 <li class="blockList"><a name="constructor.summary">
125 <h3>Constructor Summary</h3>
126 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
127 <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
129 <th class="colOne" scope="col">Constructor and Description</th>
131 <tr class="altColor">
132 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2Flow.html#Layer2Flow-org.pcap4j.util.MacAddress-org.pcap4j.util.MacAddress-">Layer2Flow</a></span>(org.pcap4j.util.MacAddress endpoint1,
133 org.pcap4j.util.MacAddress endpoint2)</code> </td>
138 <!-- ========== METHOD SUMMARY =========== -->
139 <ul class="blockList">
140 <li class="blockList"><a name="method.summary">
143 <h3>Method Summary</h3>
144 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
145 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
147 <th class="colFirst" scope="col">Modifier and Type</th>
148 <th class="colLast" scope="col">Method and Description</th>
150 <tr id="i0" class="altColor">
151 <td class="colFirst"><code>void</code></td>
152 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2Flow.html#addFlowObserver-edu.uci.iotproject.trafficreassembly.layer2.Layer2FlowObserver-">addFlowObserver</a></span>(<a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2FlowObserver.html" title="interface in edu.uci.iotproject.trafficreassembly.layer2">Layer2FlowObserver</a> observer)</code>
153 <div class="block">Register as an observer of this flow.</div>
156 <tr id="i1" class="rowColor">
157 <td class="colFirst"><code>void</code></td>
158 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2Flow.html#addPacket-org.pcap4j.core.PcapPacket-">addPacket</a></span>(org.pcap4j.core.PcapPacket packet)</code>
159 <div class="block">Add a packet to this flow.</div>
162 <tr id="i2" class="altColor">
163 <td class="colFirst"><code>org.pcap4j.util.MacAddress</code></td>
164 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2Flow.html#getEndpoint1--">getEndpoint1</a></span>()</code>
165 <div class="block">Get the first endpoint of this flow.</div>
168 <tr id="i3" class="rowColor">
169 <td class="colFirst"><code>org.pcap4j.util.MacAddress</code></td>
170 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2Flow.html#getEndpoint2--">getEndpoint2</a></span>()</code>
171 <div class="block">Get the second endpoint of this flow.</div>
174 <tr id="i4" class="altColor">
175 <td class="colFirst"><code>java.util.List<org.pcap4j.core.PcapPacket></code></td>
176 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2Flow.html#getPackets--">getPackets</a></span>()</code>
177 <div class="block">Get the packets pertaining to this flow.</div>
180 <tr id="i5" class="rowColor">
181 <td class="colFirst"><code>void</code></td>
182 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2Flow.html#removeFlowObserver-edu.uci.iotproject.trafficreassembly.layer2.Layer2FlowObserver-">removeFlowObserver</a></span>(<a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2FlowObserver.html" title="interface in edu.uci.iotproject.trafficreassembly.layer2">Layer2FlowObserver</a> observer)</code>
183 <div class="block">Deregister as an observer of this flow.</div>
186 <tr id="i6" class="altColor">
187 <td class="colFirst"><code>java.lang.String</code></td>
188 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2Flow.html#toString--">toString</a></span>()</code> </td>
191 <ul class="blockList">
192 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
195 <h3>Methods inherited from class java.lang.Object</h3>
196 <code>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
203 <div class="details">
204 <ul class="blockList">
205 <li class="blockList">
206 <!-- ========= CONSTRUCTOR DETAIL ======== -->
207 <ul class="blockList">
208 <li class="blockList"><a name="constructor.detail">
211 <h3>Constructor Detail</h3>
212 <a name="Layer2Flow-org.pcap4j.util.MacAddress-org.pcap4j.util.MacAddress-">
215 <ul class="blockListLast">
216 <li class="blockList">
218 <pre>public Layer2Flow(org.pcap4j.util.MacAddress endpoint1,
219 org.pcap4j.util.MacAddress endpoint2)</pre>
224 <!-- ============ METHOD DETAIL ========== -->
225 <ul class="blockList">
226 <li class="blockList"><a name="method.detail">
229 <h3>Method Detail</h3>
230 <a name="getEndpoint1--">
233 <ul class="blockList">
234 <li class="blockList">
235 <h4>getEndpoint1</h4>
236 <pre>public org.pcap4j.util.MacAddress getEndpoint1()</pre>
237 <div class="block">Get the first endpoint of this flow.</div>
239 <dt><span class="returnLabel">Returns:</span></dt>
240 <dd>the first endpoint of this flow.</dd>
244 <a name="getEndpoint2--">
247 <ul class="blockList">
248 <li class="blockList">
249 <h4>getEndpoint2</h4>
250 <pre>public org.pcap4j.util.MacAddress getEndpoint2()</pre>
251 <div class="block">Get the second endpoint of this flow.</div>
253 <dt><span class="returnLabel">Returns:</span></dt>
254 <dd>the second endpoint of this flow.</dd>
258 <a name="addFlowObserver-edu.uci.iotproject.trafficreassembly.layer2.Layer2FlowObserver-">
261 <ul class="blockList">
262 <li class="blockList">
263 <h4>addFlowObserver</h4>
264 <pre>public void addFlowObserver(<a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2FlowObserver.html" title="interface in edu.uci.iotproject.trafficreassembly.layer2">Layer2FlowObserver</a> observer)</pre>
265 <div class="block">Register as an observer of this flow.</div>
267 <dt><span class="paramLabel">Parameters:</span></dt>
268 <dd><code>observer</code> - The client that is to be notified whenever this flow changes (has new packets added).</dd>
272 <a name="removeFlowObserver-edu.uci.iotproject.trafficreassembly.layer2.Layer2FlowObserver-">
275 <ul class="blockList">
276 <li class="blockList">
277 <h4>removeFlowObserver</h4>
278 <pre>public void removeFlowObserver(<a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2FlowObserver.html" title="interface in edu.uci.iotproject.trafficreassembly.layer2">Layer2FlowObserver</a> observer)</pre>
279 <div class="block">Deregister as an observer of this flow.</div>
281 <dt><span class="paramLabel">Parameters:</span></dt>
282 <dd><code>observer</code> - The client that no longer wishes to be notified whenever this flow changes.</dd>
286 <a name="addPacket-org.pcap4j.core.PcapPacket-">
289 <ul class="blockList">
290 <li class="blockList">
292 <pre>public void addPacket(org.pcap4j.core.PcapPacket packet)</pre>
293 <div class="block">Add a packet to this flow.</div>
295 <dt><span class="paramLabel">Parameters:</span></dt>
296 <dd><code>packet</code> - The packet that is to be added to the flow.</dd>
300 <a name="getPackets--">
303 <ul class="blockList">
304 <li class="blockList">
306 <pre>public java.util.List<org.pcap4j.core.PcapPacket> getPackets()</pre>
307 <div class="block">Get the packets pertaining to this flow.</div>
309 <dt><span class="returnLabel">Returns:</span></dt>
310 <dd>The packets pertaining to this flow.</dd>
314 <a name="toString--">
317 <ul class="blockListLast">
318 <li class="blockList">
320 <pre>public java.lang.String toString()</pre>
322 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
323 <dd><code>toString</code> in class <code>java.lang.Object</code></dd>
333 <!-- ========= END OF CLASS DATA ========= -->
334 <!-- ======= START OF BOTTOM NAVBAR ====== -->
335 <div class="bottomNav"><a name="navbar.bottom">
338 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
339 <a name="navbar.bottom.firstrow">
342 <ul class="navList" title="Navigation">
343 <li><a href="../../../../../overview-summary.html">Overview</a></li>
344 <li><a href="package-summary.html">Package</a></li>
345 <li class="navBarCell1Rev">Class</li>
346 <li><a href="package-tree.html">Tree</a></li>
347 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
348 <li><a href="../../../../../index-files/index-1.html">Index</a></li>
349 <li><a href="../../../../../help-doc.html">Help</a></li>
354 <li>Prev Class</li>
355 <li><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2FlowObserver.html" title="interface in edu.uci.iotproject.trafficreassembly.layer2"><span class="typeNameLink">Next Class</span></a></li>
358 <li><a href="../../../../../index.html?edu/uci/iotproject/trafficreassembly/layer2/Layer2Flow.html" target="_top">Frames</a></li>
359 <li><a href="Layer2Flow.html" target="_top">No Frames</a></li>
361 <ul class="navList" id="allclasses_navbar_bottom">
362 <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
365 <script type="text/javascript"><!--
366 allClassesLink = document.getElementById("allclasses_navbar_bottom");
368 allClassesLink.style.display = "block";
371 allClassesLink.style.display = "none";
377 <ul class="subNavList">
378 <li>Summary: </li>
379 <li>Nested | </li>
380 <li>Field | </li>
381 <li><a href="#constructor.summary">Constr</a> | </li>
382 <li><a href="#method.summary">Method</a></li>
384 <ul class="subNavList">
385 <li>Detail: </li>
386 <li>Field | </li>
387 <li><a href="#constructor.detail">Constr</a> | </li>
388 <li><a href="#method.detail">Method</a></li>
391 <a name="skip.navbar.bottom">
394 <!-- ======== END OF BOTTOM NAVBAR ======= -->