Adding Javadoc documentation.
[pingpong.git] / Code / Projects / PacketLevelSignatureExtractor / javadoc / edu / uci / iotproject / analysis / PcapPacketPair.html
diff --git a/Code/Projects/PacketLevelSignatureExtractor/javadoc/edu/uci/iotproject/analysis/PcapPacketPair.html b/Code/Projects/PacketLevelSignatureExtractor/javadoc/edu/uci/iotproject/analysis/PcapPacketPair.html
new file mode 100644 (file)
index 0000000..e442318
--- /dev/null
@@ -0,0 +1,411 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (1.8.0_191) on Thu Mar 28 11:26:58 PDT 2019 -->
+<title>PcapPacketPair</title>
+<meta name="date" content="2019-03-28">
+<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+    try {
+        if (location.href.indexOf('is-external=true') == -1) {
+            parent.document.title="PcapPacketPair";
+        }
+    }
+    catch(err) {
+    }
+//-->
+var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!--   -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!--   -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../index-files/index-1.html">Index</a></li>
+<li><a href="../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<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>
+<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>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?edu/uci/iotproject/analysis/PcapPacketPair.html" target="_top">Frames</a></li>
+<li><a href="PcapPacketPair.html" target="_top">No&nbsp;Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+  allClassesLink = document.getElementById("allclasses_navbar_top");
+  if(window==top) {
+    allClassesLink.style.display = "block";
+  }
+  else {
+    allClassesLink.style.display = "none";
+  }
+  //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!--   -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">edu.uci.iotproject.analysis</div>
+<h2 title="Class PcapPacketPair" class="title">Class PcapPacketPair</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>edu.uci.iotproject.analysis.PcapPacketPair</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<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>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="typeNameLabel">PcapPacketPair</span>
+extends java.lang.Object
+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>
+<div class="block"><p>
+     A simple wrapper for holding a pair of packets (e.g., a request and associated reply packet).
+ </p>
+
+ <b>Note:</b> we use the deprecated version</div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.summary">
+<!--   -->
+</a>
+<h3>Constructor Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
+<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colOne" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<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,
+              org.pcap4j.core.PcapPacket&nbsp;second)</code>&nbsp;</td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!--   -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<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>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code><a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html" title="class in edu.uci.iotproject.analysis">PcapPacketPair</a></code></td>
+<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>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>double</code></td>
+<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>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code><a href="../../../../edu/uci/iotproject/DnsMap.html" title="class in edu.uci.iotproject">DnsMap</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html#getDnsMap--">getDnsMap</a></span>()</code>
+<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>
+</td>
+</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code>org.pcap4j.core.PcapPacket</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html#getFirst--">getFirst</a></span>()</code>&nbsp;</td>
+</tr>
+<tr id="i4" class="altColor">
+<td class="colFirst"><code>java.util.Optional&lt;org.pcap4j.core.PcapPacket&gt;</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html#getSecond--">getSecond</a></span>()</code>&nbsp;</td>
+</tr>
+<tr id="i5" class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html#isFirstClient--">isFirstClient</a></span>()</code>&nbsp;</td>
+</tr>
+<tr id="i6" class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html#isSecondClient--">isSecondClient</a></span>()</code>&nbsp;</td>
+</tr>
+<tr id="i7" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<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>
+<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>
+</td>
+</tr>
+<tr id="i8" class="altColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/PcapPacketPair.html#toString--">toString</a></span>()</code>&nbsp;</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
+<!--   -->
+</a>
+<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
+<code>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.detail">
+<!--   -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="PcapPacketPair-org.pcap4j.core.PcapPacket-org.pcap4j.core.PcapPacket-">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>PcapPacketPair</h4>
+<pre>public&nbsp;PcapPacketPair(org.pcap4j.core.PcapPacket&nbsp;first,
+                      org.pcap4j.core.PcapPacket&nbsp;second)</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!--   -->
+</a>
+<h3>Method Detail</h3>
+<a name="getFirst--">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getFirst</h4>
+<pre>public&nbsp;org.pcap4j.core.PcapPacket&nbsp;getFirst()</pre>
+</li>
+</ul>
+<a name="isFirstClient--">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isFirstClient</h4>
+<pre>public&nbsp;boolean&nbsp;isFirstClient()</pre>
+</li>
+</ul>
+<a name="getSecond--">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getSecond</h4>
+<pre>public&nbsp;java.util.Optional&lt;org.pcap4j.core.PcapPacket&gt;&nbsp;getSecond()</pre>
+</li>
+</ul>
+<a name="isSecondClient--">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isSecondClient</h4>
+<pre>public&nbsp;boolean&nbsp;isSecondClient()</pre>
+</li>
+</ul>
+<a name="getDnsMap--">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getDnsMap</h4>
+<pre>public&nbsp;<a href="../../../../edu/uci/iotproject/DnsMap.html" title="class in edu.uci.iotproject">DnsMap</a>&nbsp;getDnsMap()</pre>
+<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>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<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>
+</dl>
+</li>
+</ul>
+<a name="setDnsMap-edu.uci.iotproject.DnsMap-">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setDnsMap</h4>
+<pre>public&nbsp;void&nbsp;setDnsMap(<a href="../../../../edu/uci/iotproject/DnsMap.html" title="class in edu.uci.iotproject">DnsMap</a>&nbsp;dnsMap)</pre>
+<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>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>dnsMap</code> - a <code>DnsMap</code> to be queried for hostnames mappings when performing IP/hostname-sensitive clustering.</dd>
+</dl>
+</li>
+</ul>
+<a name="toString--">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>toString</h4>
+<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
+<dl>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
+</dl>
+</li>
+</ul>
+<a name="distanceFrom-edu.uci.iotproject.analysis.PcapPacketPair-">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>distanceFrom</h4>
+<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>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<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>
+</dl>
+</li>
+</ul>
+<a name="centroidOf-java.util.Collection-">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>centroidOf</h4>
+<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>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<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>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar.bottom">
+<!--   -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!--   -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../index-files/index-1.html">Index</a></li>
+<li><a href="../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<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>
+<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>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?edu/uci/iotproject/analysis/PcapPacketPair.html" target="_top">Frames</a></li>
+<li><a href="PcapPacketPair.html" target="_top">No&nbsp;Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+  allClassesLink = document.getElementById("allclasses_navbar_bottom");
+  if(window==top) {
+    allClassesLink.style.display = "block";
+  }
+  else {
+    allClassesLink.style.display = "none";
+  }
+  //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!--   -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>