Adding Javadoc documentation.
[pingpong.git] / Code / Projects / PacketLevelSignatureExtractor / javadoc / edu / uci / iotproject / trafficreassembly / layer2 / Layer2FlowObserver.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>Layer2FlowObserver</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="Layer2FlowObserver";
16         }
17     }
18     catch(err) {
19     }
20 //-->
21 var methods = {"i0":6};
22 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/Layer2Flow.html" title="class in edu.uci.iotproject.trafficreassembly.layer2"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
52 <li><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2FlowReassembler.html" title="class 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/Layer2FlowObserver.html" target="_top">Frames</a></li>
56 <li><a href="Layer2FlowObserver.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>Constr&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>Constr&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="Interface Layer2FlowObserver" class="title">Interface Layer2FlowObserver</h2>
96 </div>
97 <div class="contentContainer">
98 <div class="description">
99 <ul class="blockList">
100 <li class="blockList">
101 <dl>
102 <dt>All Known Implementing Classes:</dt>
103 <dd><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2ClusterMatcher.html" title="class in edu.uci.iotproject.detection.layer2">Layer2ClusterMatcher</a></dd>
104 </dl>
105 <hr>
106 <br>
107 <pre>public interface <span class="typeNameLabel">Layer2FlowObserver</span></pre>
108 <div class="block">Interface for observing a <a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2Flow.html" title="class in edu.uci.iotproject.trafficreassembly.layer2"><code>Layer2Flow</code></a>.</div>
109 </li>
110 </ul>
111 </div>
112 <div class="summary">
113 <ul class="blockList">
114 <li class="blockList">
115 <!-- ========== METHOD SUMMARY =========== -->
116 <ul class="blockList">
117 <li class="blockList"><a name="method.summary">
118 <!--   -->
119 </a>
120 <h3>Method Summary</h3>
121 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
122 <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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
123 <tr>
124 <th class="colFirst" scope="col">Modifier and Type</th>
125 <th class="colLast" scope="col">Method and Description</th>
126 </tr>
127 <tr id="i0" class="altColor">
128 <td class="colFirst"><code>void</code></td>
129 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2FlowObserver.html#onNewPacket-edu.uci.iotproject.trafficreassembly.layer2.Layer2Flow-org.pcap4j.core.PcapPacket-">onNewPacket</a></span>(<a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2Flow.html" title="class in edu.uci.iotproject.trafficreassembly.layer2">Layer2Flow</a>&nbsp;flow,
130            org.pcap4j.core.PcapPacket&nbsp;newPacket)</code>
131 <div class="block">Invoked when a new packet is added to the observed flow.</div>
132 </td>
133 </tr>
134 </table>
135 </li>
136 </ul>
137 </li>
138 </ul>
139 </div>
140 <div class="details">
141 <ul class="blockList">
142 <li class="blockList">
143 <!-- ============ METHOD DETAIL ========== -->
144 <ul class="blockList">
145 <li class="blockList"><a name="method.detail">
146 <!--   -->
147 </a>
148 <h3>Method Detail</h3>
149 <a name="onNewPacket-edu.uci.iotproject.trafficreassembly.layer2.Layer2Flow-org.pcap4j.core.PcapPacket-">
150 <!--   -->
151 </a>
152 <ul class="blockListLast">
153 <li class="blockList">
154 <h4>onNewPacket</h4>
155 <pre>void&nbsp;onNewPacket(<a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2Flow.html" title="class in edu.uci.iotproject.trafficreassembly.layer2">Layer2Flow</a>&nbsp;flow,
156                  org.pcap4j.core.PcapPacket&nbsp;newPacket)</pre>
157 <div class="block">Invoked when a new packet is added to the observed flow.</div>
158 <dl>
159 <dt><span class="paramLabel">Parameters:</span></dt>
160 <dd><code>flow</code> - The observed flow.</dd>
161 <dd><code>newPacket</code> - The packet that was added to the flow.</dd>
162 </dl>
163 </li>
164 </ul>
165 </li>
166 </ul>
167 </li>
168 </ul>
169 </div>
170 </div>
171 <!-- ========= END OF CLASS DATA ========= -->
172 <!-- ======= START OF BOTTOM NAVBAR ====== -->
173 <div class="bottomNav"><a name="navbar.bottom">
174 <!--   -->
175 </a>
176 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
177 <a name="navbar.bottom.firstrow">
178 <!--   -->
179 </a>
180 <ul class="navList" title="Navigation">
181 <li><a href="../../../../../overview-summary.html">Overview</a></li>
182 <li><a href="package-summary.html">Package</a></li>
183 <li class="navBarCell1Rev">Class</li>
184 <li><a href="package-tree.html">Tree</a></li>
185 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
186 <li><a href="../../../../../index-files/index-1.html">Index</a></li>
187 <li><a href="../../../../../help-doc.html">Help</a></li>
188 </ul>
189 </div>
190 <div class="subNav">
191 <ul class="navList">
192 <li><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2Flow.html" title="class in edu.uci.iotproject.trafficreassembly.layer2"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
193 <li><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer2/Layer2FlowReassembler.html" title="class in edu.uci.iotproject.trafficreassembly.layer2"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
194 </ul>
195 <ul class="navList">
196 <li><a href="../../../../../index.html?edu/uci/iotproject/trafficreassembly/layer2/Layer2FlowObserver.html" target="_top">Frames</a></li>
197 <li><a href="Layer2FlowObserver.html" target="_top">No&nbsp;Frames</a></li>
198 </ul>
199 <ul class="navList" id="allclasses_navbar_bottom">
200 <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
201 </ul>
202 <div>
203 <script type="text/javascript"><!--
204   allClassesLink = document.getElementById("allclasses_navbar_bottom");
205   if(window==top) {
206     allClassesLink.style.display = "block";
207   }
208   else {
209     allClassesLink.style.display = "none";
210   }
211   //-->
212 </script>
213 </div>
214 <div>
215 <ul class="subNavList">
216 <li>Summary:&nbsp;</li>
217 <li>Nested&nbsp;|&nbsp;</li>
218 <li>Field&nbsp;|&nbsp;</li>
219 <li>Constr&nbsp;|&nbsp;</li>
220 <li><a href="#method.summary">Method</a></li>
221 </ul>
222 <ul class="subNavList">
223 <li>Detail:&nbsp;</li>
224 <li>Field&nbsp;|&nbsp;</li>
225 <li>Constr&nbsp;|&nbsp;</li>
226 <li><a href="#method.detail">Method</a></li>
227 </ul>
228 </div>
229 <a name="skip.navbar.bottom">
230 <!--   -->
231 </a></div>
232 <!-- ======== END OF BOTTOM NAVBAR ======= -->
233 </body>
234 </html>