Adding Javadoc documentation.
[pingpong.git] / Code / Projects / PacketLevelSignatureExtractor / javadoc / index-files / index-14.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:27:00 PDT 2019 -->
6 <title>P-Index</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="P-Index";
16         }
17     }
18     catch(err) {
19     }
20 //-->
21 </script>
22 <noscript>
23 <div>JavaScript is disabled on your browser.</div>
24 </noscript>
25 <!-- ========= START OF TOP NAVBAR ======= -->
26 <div class="topNav"><a name="navbar.top">
27 <!--   -->
28 </a>
29 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
30 <a name="navbar.top.firstrow">
31 <!--   -->
32 </a>
33 <ul class="navList" title="Navigation">
34 <li><a href="../overview-summary.html">Overview</a></li>
35 <li>Package</li>
36 <li>Class</li>
37 <li><a href="../overview-tree.html">Tree</a></li>
38 <li><a href="../deprecated-list.html">Deprecated</a></li>
39 <li class="navBarCell1Rev">Index</li>
40 <li><a href="../help-doc.html">Help</a></li>
41 </ul>
42 </div>
43 <div class="subNav">
44 <ul class="navList">
45 <li><a href="index-13.html">Prev Letter</a></li>
46 <li><a href="index-15.html">Next Letter</a></li>
47 </ul>
48 <ul class="navList">
49 <li><a href="../index.html?index-files/index-14.html" target="_top">Frames</a></li>
50 <li><a href="index-14.html" target="_top">No&nbsp;Frames</a></li>
51 </ul>
52 <ul class="navList" id="allclasses_navbar_top">
53 <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
54 </ul>
55 <div>
56 <script type="text/javascript"><!--
57   allClassesLink = document.getElementById("allclasses_navbar_top");
58   if(window==top) {
59     allClassesLink.style.display = "block";
60   }
61   else {
62     allClassesLink.style.display = "none";
63   }
64   //-->
65 </script>
66 </div>
67 <a name="skip.navbar.top">
68 <!--   -->
69 </a></div>
70 <!-- ========= END OF TOP NAVBAR ========= -->
71 <div class="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">C</a>&nbsp;<a href="index-3.html">D</a>&nbsp;<a href="index-4.html">E</a>&nbsp;<a href="index-5.html">F</a>&nbsp;<a href="index-6.html">G</a>&nbsp;<a href="index-7.html">H</a>&nbsp;<a href="index-8.html">I</a>&nbsp;<a href="index-9.html">K</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">T</a>&nbsp;<a href="index-18.html">U</a>&nbsp;<a href="index-19.html">V</a>&nbsp;<a href="index-20.html">Z</a>&nbsp;<a name="I:P">
72 <!--   -->
73 </a>
74 <h2 class="title">P</h2>
75 <dl>
76 <dt><span class="memberNameLink"><a href="../edu/uci/iotproject/io/TriggerTimesFileReader.html#parseTriggerTimestamp-java.lang.String-boolean-">parseTriggerTimestamp(String, boolean)</a></span> - Method in class edu.uci.iotproject.io.<a href="../edu/uci/iotproject/io/TriggerTimesFileReader.html" title="class in edu.uci.iotproject.io">TriggerTimesFileReader</a></dt>
77 <dd>
78 <div class="block">Parses a timestamp string to an <code>Instant</code> (UTC).</div>
79 </dd>
80 <dt><a href="../edu/uci/iotproject/io/PcapHandleReader.html" title="class in edu.uci.iotproject.io"><span class="typeNameLink">PcapHandleReader</span></a> - Class in <a href="../edu/uci/iotproject/io/package-summary.html">edu.uci.iotproject.io</a></dt>
81 <dd>
82 <div class="block">Reads packets from a <code>PcapHandle</code> (online or offline) and delivers those packets that pass the test exercised
83  by the provided <a href="../edu/uci/iotproject/analysis/PcapPacketFilter.html" title="interface in edu.uci.iotproject.analysis"><code>PcapPacketFilter</code></a> onto the provided <code>PacketListener</code>s.</div>
84 </dd>
85 <dt><span class="memberNameLink"><a href="../edu/uci/iotproject/io/PcapHandleReader.html#PcapHandleReader-org.pcap4j.core.PcapHandle-edu.uci.iotproject.analysis.PcapPacketFilter-org.pcap4j.core.PacketListener...-">PcapHandleReader(PcapHandle, PcapPacketFilter, PacketListener...)</a></span> - Constructor for class edu.uci.iotproject.io.<a href="../edu/uci/iotproject/io/PcapHandleReader.html" title="class in edu.uci.iotproject.io">PcapHandleReader</a></dt>
86 <dd>
87 <div class="block">Create a <code>PcapHandleReader</code>.</div>
88 </dd>
89 <dt><a href="../edu/uci/iotproject/analysis/PcapPacketFilter.html" title="interface in edu.uci.iotproject.analysis"><span class="typeNameLink">PcapPacketFilter</span></a> - Interface in <a href="../edu/uci/iotproject/analysis/package-summary.html">edu.uci.iotproject.analysis</a></dt>
90 <dd>
91 <div class="block">TODO add class documentation.</div>
92 </dd>
93 <dt><a href="../edu/uci/iotproject/analysis/PcapPacketPair.html" title="class in edu.uci.iotproject.analysis"><span class="typeNameLink">PcapPacketPair</span></a> - Class in <a href="../edu/uci/iotproject/analysis/package-summary.html">edu.uci.iotproject.analysis</a></dt>
94 <dd>
95 <div class="block">
96      A simple wrapper for holding a pair of packets (e.g., a request and associated reply packet).</div>
97 </dd>
98 <dt><span class="memberNameLink"><a href="../edu/uci/iotproject/analysis/PcapPacketPair.html#PcapPacketPair-org.pcap4j.core.PcapPacket-org.pcap4j.core.PcapPacket-">PcapPacketPair(PcapPacket, PcapPacket)</a></span> - Constructor for class edu.uci.iotproject.analysis.<a href="../edu/uci/iotproject/analysis/PcapPacketPair.html" title="class in edu.uci.iotproject.analysis">PcapPacketPair</a></dt>
99 <dd>&nbsp;</dd>
100 <dt><a href="../edu/uci/iotproject/util/PcapPacketUtils.html" title="class in edu.uci.iotproject.util"><span class="typeNameLink">PcapPacketUtils</span></a> - Class in <a href="../edu/uci/iotproject/util/package-summary.html">edu.uci.iotproject.util</a></dt>
101 <dd>
102 <div class="block">Utility methods for inspecting <code>PcapPacket</code> properties.</div>
103 </dd>
104 <dt><span class="memberNameLink"><a href="../edu/uci/iotproject/util/PcapPacketUtils.html#PcapPacketUtils--">PcapPacketUtils()</a></span> - Constructor for class edu.uci.iotproject.util.<a href="../edu/uci/iotproject/util/PcapPacketUtils.html" title="class in edu.uci.iotproject.util">PcapPacketUtils</a></dt>
105 <dd>&nbsp;</dd>
106 <dt><span class="memberNameLink"><a href="../edu/uci/iotproject/detection/layer3/Layer3ClusterMatcher.html#performDetectionConservative--">performDetectionConservative()</a></span> - Method in class edu.uci.iotproject.detection.layer3.<a href="../edu/uci/iotproject/detection/layer3/Layer3ClusterMatcher.html" title="class in edu.uci.iotproject.detection.layer3">Layer3ClusterMatcher</a></dt>
107 <dd>&nbsp;</dd>
108 <dt><span class="memberNameLink"><a href="../edu/uci/iotproject/detection/layer3/Layer3ClusterMatcher.html#performDetectionRangeBased--">performDetectionRangeBased()</a></span> - Method in class edu.uci.iotproject.detection.layer3.<a href="../edu/uci/iotproject/detection/layer3/Layer3ClusterMatcher.html" title="class in edu.uci.iotproject.detection.layer3">Layer3ClusterMatcher</a></dt>
109 <dd>&nbsp;</dd>
110 <dt><span class="memberNameLink"><a href="../edu/uci/iotproject/analysis/TriggerTrafficExtractor.html#performExtraction-org.pcap4j.core.PacketListener...-">performExtraction(PacketListener...)</a></span> - Method in class edu.uci.iotproject.analysis.<a href="../edu/uci/iotproject/analysis/TriggerTrafficExtractor.html" title="class in edu.uci.iotproject.analysis">TriggerTrafficExtractor</a></dt>
111 <dd>&nbsp;</dd>
112 <dt><span class="memberNameLink"><a href="../edu/uci/iotproject/io/PrintWriterUtils.html#print-java.lang.Object-java.io.PrintWriter-boolean-">print(Object, PrintWriter, boolean)</a></span> - Static method in class edu.uci.iotproject.io.<a href="../edu/uci/iotproject/io/PrintWriterUtils.html" title="class in edu.uci.iotproject.io">PrintWriterUtils</a></dt>
113 <dd>
114 <div class="block">Invoke <code>PrintWriter.println(Object)</code> passing <code>line</code> as argument while also printing <code>line</code> to
115  standard output if <code>duplicateToStdOut</code> is <code>true</code>.</div>
116 </dd>
117 <dt><span class="memberNameLink"><a href="../edu/uci/iotproject/io/PrintWriterUtils.html#printEmptyLine-java.io.PrintWriter-boolean-">printEmptyLine(PrintWriter, boolean)</a></span> - Static method in class edu.uci.iotproject.io.<a href="../edu/uci/iotproject/io/PrintWriterUtils.html" title="class in edu.uci.iotproject.io">PrintWriterUtils</a></dt>
118 <dd>
119 <div class="block">Make writer (and standard output, if <code>duplicateToStdOut</code> is <code>true</code>) print an empty line.</div>
120 </dd>
121 <dt><span class="memberNameLink"><a href="../edu/uci/iotproject/io/PrintWriterUtils.html#println-java.lang.Object-java.io.PrintWriter-boolean-">println(Object, PrintWriter, boolean)</a></span> - Static method in class edu.uci.iotproject.io.<a href="../edu/uci/iotproject/io/PrintWriterUtils.html" title="class in edu.uci.iotproject.io">PrintWriterUtils</a></dt>
122 <dd>
123 <div class="block">Invoke <code>PrintWriter.println(Object)</code> passing <code>line</code> as argument while also printing <code>line</code> to
124  standard output if <code>duplicateToStdOut</code> is <code>true</code>.</div>
125 </dd>
126 <dt><span class="memberNameLink"><a href="../edu/uci/iotproject/util/PcapPacketUtils.html#printSignatures-java.util.List-java.io.PrintWriter-boolean-">printSignatures(List&lt;List&lt;List&lt;PcapPacket&gt;&gt;&gt;, PrintWriter, boolean)</a></span> - Static method in class edu.uci.iotproject.util.<a href="../edu/uci/iotproject/util/PcapPacketUtils.html" title="class in edu.uci.iotproject.util">PcapPacketUtils</a></dt>
127 <dd>
128 <div class="block">Print signatures in <code>List</code> of <code>List</code> of <code>List</code> of <code>PcapPacket</code> objects.</div>
129 </dd>
130 <dt><a href="../edu/uci/iotproject/util/PrintUtils.html" title="class in edu.uci.iotproject.util"><span class="typeNameLink">PrintUtils</span></a> - Class in <a href="../edu/uci/iotproject/util/package-summary.html">edu.uci.iotproject.util</a></dt>
131 <dd>
132 <div class="block">Utility methods for generating (output) strings.</div>
133 </dd>
134 <dt><a href="../edu/uci/iotproject/io/PrintWriterUtils.html" title="class in edu.uci.iotproject.io"><span class="typeNameLink">PrintWriterUtils</span></a> - Class in <a href="../edu/uci/iotproject/io/package-summary.html">edu.uci.iotproject.io</a></dt>
135 <dd>
136 <div class="block">Utility methods for (jointly) printing to a <code>PrintWriter</code> (and standard output).</div>
137 </dd>
138 </dl>
139 <a href="index-1.html">A</a>&nbsp;<a href="index-2.html">C</a>&nbsp;<a href="index-3.html">D</a>&nbsp;<a href="index-4.html">E</a>&nbsp;<a href="index-5.html">F</a>&nbsp;<a href="index-6.html">G</a>&nbsp;<a href="index-7.html">H</a>&nbsp;<a href="index-8.html">I</a>&nbsp;<a href="index-9.html">K</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">T</a>&nbsp;<a href="index-18.html">U</a>&nbsp;<a href="index-19.html">V</a>&nbsp;<a href="index-20.html">Z</a>&nbsp;</div>
140 <!-- ======= START OF BOTTOM NAVBAR ====== -->
141 <div class="bottomNav"><a name="navbar.bottom">
142 <!--   -->
143 </a>
144 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
145 <a name="navbar.bottom.firstrow">
146 <!--   -->
147 </a>
148 <ul class="navList" title="Navigation">
149 <li><a href="../overview-summary.html">Overview</a></li>
150 <li>Package</li>
151 <li>Class</li>
152 <li><a href="../overview-tree.html">Tree</a></li>
153 <li><a href="../deprecated-list.html">Deprecated</a></li>
154 <li class="navBarCell1Rev">Index</li>
155 <li><a href="../help-doc.html">Help</a></li>
156 </ul>
157 </div>
158 <div class="subNav">
159 <ul class="navList">
160 <li><a href="index-13.html">Prev Letter</a></li>
161 <li><a href="index-15.html">Next Letter</a></li>
162 </ul>
163 <ul class="navList">
164 <li><a href="../index.html?index-files/index-14.html" target="_top">Frames</a></li>
165 <li><a href="index-14.html" target="_top">No&nbsp;Frames</a></li>
166 </ul>
167 <ul class="navList" id="allclasses_navbar_bottom">
168 <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
169 </ul>
170 <div>
171 <script type="text/javascript"><!--
172   allClassesLink = document.getElementById("allclasses_navbar_bottom");
173   if(window==top) {
174     allClassesLink.style.display = "block";
175   }
176   else {
177     allClassesLink.style.display = "none";
178   }
179   //-->
180 </script>
181 </div>
182 <a name="skip.navbar.bottom">
183 <!--   -->
184 </a></div>
185 <!-- ======== END OF BOTTOM NAVBAR ======= -->
186 </body>
187 </html>