Adding Javadoc documentation.
[pingpong.git] / Code / Projects / PacketLevelSignatureExtractor / javadoc / edu / uci / iotproject / analysis / PcapPacketPair.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>PcapPacketPair</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="PcapPacketPair";
16         }
17     }
18     catch(err) {
19     }
20 //-->
21 var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":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/analysis/PcapPacketFilter.html" title="interface in edu.uci.iotproject.analysis"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
52 <li><a href="../../../../edu/uci/iotproject/analysis/TcpConversationUtils.html" title="class in edu.uci.iotproject.analysis"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
53 </ul>
54 <ul class="navList">
55 <li><a href="../../../../index.html?edu/uci/iotproject/analysis/PcapPacketPair.html" target="_top">Frames</a></li>
56 <li><a href="PcapPacketPair.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.analysis</div>
95 <h2 title="Class PcapPacketPair" class="title">Class PcapPacketPair</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.analysis.PcapPacketPair</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.apache.commons.math3.stat.clustering.Clusterable&lt;<a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html" title="class in edu.uci.iotproject.analysis">PcapPacketPair</a>&gt;</dd>
112 </dl>
113 <hr>
114 <br>
115 <pre>public class <span class="typeNameLabel">PcapPacketPair</span>
116 extends java.lang.Object
117 implements org.apache.commons.math3.stat.clustering.Clusterable&lt;<a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html" title="class in edu.uci.iotproject.analysis">PcapPacketPair</a>&gt;</pre>
118 <div class="block"><p>
119      A simple wrapper for holding a pair of packets (e.g., a request and associated reply packet).
120  </p>
121
122  <b>Note:</b> we use the deprecated version</div>
123 </li>
124 </ul>
125 </div>
126 <div class="summary">
127 <ul class="blockList">
128 <li class="blockList">
129 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
130 <ul class="blockList">
131 <li class="blockList"><a name="constructor.summary">
132 <!--   -->
133 </a>
134 <h3>Constructor Summary</h3>
135 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
136 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
137 <tr>
138 <th class="colOne" scope="col">Constructor and Description</th>
139 </tr>
140 <tr class="altColor">
141 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html#PcapPacketPair-org.pcap4j.core.PcapPacket-org.pcap4j.core.PcapPacket-">PcapPacketPair</a></span>(org.pcap4j.core.PcapPacket&nbsp;first,
142               org.pcap4j.core.PcapPacket&nbsp;second)</code>&nbsp;</td>
143 </tr>
144 </table>
145 </li>
146 </ul>
147 <!-- ========== METHOD SUMMARY =========== -->
148 <ul class="blockList">
149 <li class="blockList"><a name="method.summary">
150 <!--   -->
151 </a>
152 <h3>Method Summary</h3>
153 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
154 <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>
155 <tr>
156 <th class="colFirst" scope="col">Modifier and Type</th>
157 <th class="colLast" scope="col">Method and Description</th>
158 </tr>
159 <tr id="i0" class="altColor">
160 <td class="colFirst"><code><a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html" title="class in edu.uci.iotproject.analysis">PcapPacketPair</a></code></td>
161 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html#centroidOf-java.util.Collection-">centroidOf</a></span>(java.util.Collection&lt;<a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html" title="class in edu.uci.iotproject.analysis">PcapPacketPair</a>&gt;&nbsp;p)</code>&nbsp;</td>
162 </tr>
163 <tr id="i1" class="rowColor">
164 <td class="colFirst"><code>double</code></td>
165 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html#distanceFrom-edu.uci.iotproject.analysis.PcapPacketPair-">distanceFrom</a></span>(<a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html" title="class in edu.uci.iotproject.analysis">PcapPacketPair</a>&nbsp;that)</code>&nbsp;</td>
166 </tr>
167 <tr id="i2" class="altColor">
168 <td class="colFirst"><code><a href="../../../../edu/uci/iotproject/DnsMap.html" title="class in edu.uci.iotproject">DnsMap</a></code></td>
169 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html#getDnsMap--">getDnsMap</a></span>()</code>
170 <div class="block">Get the <a href="../../../../edu/uci/iotproject/DnsMap.html" title="class in edu.uci.iotproject"><code>DnsMap</code></a> that is queried for hostnames mappings when performing IP/hostname-sensitive clustering.</div>
171 </td>
172 </tr>
173 <tr id="i3" class="rowColor">
174 <td class="colFirst"><code>org.pcap4j.core.PcapPacket</code></td>
175 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html#getFirst--">getFirst</a></span>()</code>&nbsp;</td>
176 </tr>
177 <tr id="i4" class="altColor">
178 <td class="colFirst"><code>java.util.Optional&lt;org.pcap4j.core.PcapPacket&gt;</code></td>
179 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html#getSecond--">getSecond</a></span>()</code>&nbsp;</td>
180 </tr>
181 <tr id="i5" class="rowColor">
182 <td class="colFirst"><code>boolean</code></td>
183 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html#isFirstClient--">isFirstClient</a></span>()</code>&nbsp;</td>
184 </tr>
185 <tr id="i6" class="altColor">
186 <td class="colFirst"><code>boolean</code></td>
187 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html#isSecondClient--">isSecondClient</a></span>()</code>&nbsp;</td>
188 </tr>
189 <tr id="i7" class="rowColor">
190 <td class="colFirst"><code>void</code></td>
191 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html#setDnsMap-edu.uci.iotproject.DnsMap-">setDnsMap</a></span>(<a href="../../../../edu/uci/iotproject/DnsMap.html" title="class in edu.uci.iotproject">DnsMap</a>&nbsp;dnsMap)</code>
192 <div class="block">Set the <a href="../../../../edu/uci/iotproject/DnsMap.html" title="class in edu.uci.iotproject"><code>DnsMap</code></a> to be queried for hostnames mappings when performing IP/hostname-sensitive clustering.</div>
193 </td>
194 </tr>
195 <tr id="i8" class="altColor">
196 <td class="colFirst"><code>java.lang.String</code></td>
197 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html#toString--">toString</a></span>()</code>&nbsp;</td>
198 </tr>
199 </table>
200 <ul class="blockList">
201 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
202 <!--   -->
203 </a>
204 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
205 <code>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
206 </ul>
207 </li>
208 </ul>
209 </li>
210 </ul>
211 </div>
212 <div class="details">
213 <ul class="blockList">
214 <li class="blockList">
215 <!-- ========= CONSTRUCTOR DETAIL ======== -->
216 <ul class="blockList">
217 <li class="blockList"><a name="constructor.detail">
218 <!--   -->
219 </a>
220 <h3>Constructor Detail</h3>
221 <a name="PcapPacketPair-org.pcap4j.core.PcapPacket-org.pcap4j.core.PcapPacket-">
222 <!--   -->
223 </a>
224 <ul class="blockListLast">
225 <li class="blockList">
226 <h4>PcapPacketPair</h4>
227 <pre>public&nbsp;PcapPacketPair(org.pcap4j.core.PcapPacket&nbsp;first,
228                       org.pcap4j.core.PcapPacket&nbsp;second)</pre>
229 </li>
230 </ul>
231 </li>
232 </ul>
233 <!-- ============ METHOD DETAIL ========== -->
234 <ul class="blockList">
235 <li class="blockList"><a name="method.detail">
236 <!--   -->
237 </a>
238 <h3>Method Detail</h3>
239 <a name="getFirst--">
240 <!--   -->
241 </a>
242 <ul class="blockList">
243 <li class="blockList">
244 <h4>getFirst</h4>
245 <pre>public&nbsp;org.pcap4j.core.PcapPacket&nbsp;getFirst()</pre>
246 </li>
247 </ul>
248 <a name="isFirstClient--">
249 <!--   -->
250 </a>
251 <ul class="blockList">
252 <li class="blockList">
253 <h4>isFirstClient</h4>
254 <pre>public&nbsp;boolean&nbsp;isFirstClient()</pre>
255 </li>
256 </ul>
257 <a name="getSecond--">
258 <!--   -->
259 </a>
260 <ul class="blockList">
261 <li class="blockList">
262 <h4>getSecond</h4>
263 <pre>public&nbsp;java.util.Optional&lt;org.pcap4j.core.PcapPacket&gt;&nbsp;getSecond()</pre>
264 </li>
265 </ul>
266 <a name="isSecondClient--">
267 <!--   -->
268 </a>
269 <ul class="blockList">
270 <li class="blockList">
271 <h4>isSecondClient</h4>
272 <pre>public&nbsp;boolean&nbsp;isSecondClient()</pre>
273 </li>
274 </ul>
275 <a name="getDnsMap--">
276 <!--   -->
277 </a>
278 <ul class="blockList">
279 <li class="blockList">
280 <h4>getDnsMap</h4>
281 <pre>public&nbsp;<a href="../../../../edu/uci/iotproject/DnsMap.html" title="class in edu.uci.iotproject">DnsMap</a>&nbsp;getDnsMap()</pre>
282 <div class="block">Get the <a href="../../../../edu/uci/iotproject/DnsMap.html" title="class in edu.uci.iotproject"><code>DnsMap</code></a> that is queried for hostnames mappings when performing IP/hostname-sensitive clustering.</div>
283 <dl>
284 <dt><span class="returnLabel">Returns:</span></dt>
285 <dd>the <a href="../../../../edu/uci/iotproject/DnsMap.html" title="class in edu.uci.iotproject"><code>DnsMap</code></a> that is queried for hostnames mappings when performing IP/hostname-sensitive clustering.</dd>
286 </dl>
287 </li>
288 </ul>
289 <a name="setDnsMap-edu.uci.iotproject.DnsMap-">
290 <!--   -->
291 </a>
292 <ul class="blockList">
293 <li class="blockList">
294 <h4>setDnsMap</h4>
295 <pre>public&nbsp;void&nbsp;setDnsMap(<a href="../../../../edu/uci/iotproject/DnsMap.html" title="class in edu.uci.iotproject">DnsMap</a>&nbsp;dnsMap)</pre>
296 <div class="block">Set the <a href="../../../../edu/uci/iotproject/DnsMap.html" title="class in edu.uci.iotproject"><code>DnsMap</code></a> to be queried for hostnames mappings when performing IP/hostname-sensitive clustering.</div>
297 <dl>
298 <dt><span class="paramLabel">Parameters:</span></dt>
299 <dd><code>dnsMap</code> - a <code>DnsMap</code> to be queried for hostnames mappings when performing IP/hostname-sensitive clustering.</dd>
300 </dl>
301 </li>
302 </ul>
303 <a name="toString--">
304 <!--   -->
305 </a>
306 <ul class="blockList">
307 <li class="blockList">
308 <h4>toString</h4>
309 <pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
310 <dl>
311 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
312 <dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
313 </dl>
314 </li>
315 </ul>
316 <a name="distanceFrom-edu.uci.iotproject.analysis.PcapPacketPair-">
317 <!--   -->
318 </a>
319 <ul class="blockList">
320 <li class="blockList">
321 <h4>distanceFrom</h4>
322 <pre>public&nbsp;double&nbsp;distanceFrom(<a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html" title="class in edu.uci.iotproject.analysis">PcapPacketPair</a>&nbsp;that)</pre>
323 <dl>
324 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
325 <dd><code>distanceFrom</code>&nbsp;in interface&nbsp;<code>org.apache.commons.math3.stat.clustering.Clusterable&lt;<a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html" title="class in edu.uci.iotproject.analysis">PcapPacketPair</a>&gt;</code></dd>
326 </dl>
327 </li>
328 </ul>
329 <a name="centroidOf-java.util.Collection-">
330 <!--   -->
331 </a>
332 <ul class="blockListLast">
333 <li class="blockList">
334 <h4>centroidOf</h4>
335 <pre>public&nbsp;<a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html" title="class in edu.uci.iotproject.analysis">PcapPacketPair</a>&nbsp;centroidOf(java.util.Collection&lt;<a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html" title="class in edu.uci.iotproject.analysis">PcapPacketPair</a>&gt;&nbsp;p)</pre>
336 <dl>
337 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
338 <dd><code>centroidOf</code>&nbsp;in interface&nbsp;<code>org.apache.commons.math3.stat.clustering.Clusterable&lt;<a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html" title="class in edu.uci.iotproject.analysis">PcapPacketPair</a>&gt;</code></dd>
339 </dl>
340 </li>
341 </ul>
342 </li>
343 </ul>
344 </li>
345 </ul>
346 </div>
347 </div>
348 <!-- ========= END OF CLASS DATA ========= -->
349 <!-- ======= START OF BOTTOM NAVBAR ====== -->
350 <div class="bottomNav"><a name="navbar.bottom">
351 <!--   -->
352 </a>
353 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
354 <a name="navbar.bottom.firstrow">
355 <!--   -->
356 </a>
357 <ul class="navList" title="Navigation">
358 <li><a href="../../../../overview-summary.html">Overview</a></li>
359 <li><a href="package-summary.html">Package</a></li>
360 <li class="navBarCell1Rev">Class</li>
361 <li><a href="package-tree.html">Tree</a></li>
362 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
363 <li><a href="../../../../index-files/index-1.html">Index</a></li>
364 <li><a href="../../../../help-doc.html">Help</a></li>
365 </ul>
366 </div>
367 <div class="subNav">
368 <ul class="navList">
369 <li><a href="../../../../edu/uci/iotproject/analysis/PcapPacketFilter.html" title="interface in edu.uci.iotproject.analysis"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
370 <li><a href="../../../../edu/uci/iotproject/analysis/TcpConversationUtils.html" title="class in edu.uci.iotproject.analysis"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
371 </ul>
372 <ul class="navList">
373 <li><a href="../../../../index.html?edu/uci/iotproject/analysis/PcapPacketPair.html" target="_top">Frames</a></li>
374 <li><a href="PcapPacketPair.html" target="_top">No&nbsp;Frames</a></li>
375 </ul>
376 <ul class="navList" id="allclasses_navbar_bottom">
377 <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
378 </ul>
379 <div>
380 <script type="text/javascript"><!--
381   allClassesLink = document.getElementById("allclasses_navbar_bottom");
382   if(window==top) {
383     allClassesLink.style.display = "block";
384   }
385   else {
386     allClassesLink.style.display = "none";
387   }
388   //-->
389 </script>
390 </div>
391 <div>
392 <ul class="subNavList">
393 <li>Summary:&nbsp;</li>
394 <li>Nested&nbsp;|&nbsp;</li>
395 <li>Field&nbsp;|&nbsp;</li>
396 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
397 <li><a href="#method.summary">Method</a></li>
398 </ul>
399 <ul class="subNavList">
400 <li>Detail:&nbsp;</li>
401 <li>Field&nbsp;|&nbsp;</li>
402 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
403 <li><a href="#method.detail">Method</a></li>
404 </ul>
405 </div>
406 <a name="skip.navbar.bottom">
407 <!--   -->
408 </a></div>
409 <!-- ======== END OF BOTTOM NAVBAR ======= -->
410 </body>
411 </html>