Adding Javadoc documentation.
[pingpong.git] / Code / Projects / PacketLevelSignatureExtractor / javadoc / index-files / index-5.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>F-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="F-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-4.html">Prev Letter</a></li>
46 <li><a href="index-6.html">Next Letter</a></li>
47 </ul>
48 <ul class="navList">
49 <li><a href="../index.html?index-files/index-5.html" target="_top">Frames</a></li>
50 <li><a href="index-5.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:F">
72 <!--   -->
73 </a>
74 <h2 class="title">F</h2>
75 <dl>
76 <dt><span class="memberNameLink"><a href="../edu/uci/iotproject/test/SequenceAlignmentTest.html#fameAlignedWithNameShouldBe1--">fameAlignedWithNameShouldBe1()</a></span> - Method in class edu.uci.iotproject.test.<a href="../edu/uci/iotproject/test/SequenceAlignmentTest.html" title="class in edu.uci.iotproject.test">SequenceAlignmentTest</a></dt>
77 <dd>&nbsp;</dd>
78 <dt><a href="../edu/uci/iotproject/trafficreassembly/layer3/FinAckPair.html" title="class in edu.uci.iotproject.trafficreassembly.layer3"><span class="typeNameLink">FinAckPair</span></a> - Class in <a href="../edu/uci/iotproject/trafficreassembly/layer3/package-summary.html">edu.uci.iotproject.trafficreassembly.layer3</a></dt>
79 <dd>
80 <div class="block">Groups a FIN packet and its corresponding ACK packet.</div>
81 </dd>
82 <dt><span class="memberNameLink"><a href="../edu/uci/iotproject/trafficreassembly/layer3/FinAckPair.html#FinAckPair-org.pcap4j.core.PcapPacket-">FinAckPair(PcapPacket)</a></span> - Constructor for class edu.uci.iotproject.trafficreassembly.layer3.<a href="../edu/uci/iotproject/trafficreassembly/layer3/FinAckPair.html" title="class in edu.uci.iotproject.trafficreassembly.layer3">FinAckPair</a></dt>
83 <dd>
84 <div class="block">Constructs a <code>FinAckPair</code> given a FIN packet.</div>
85 </dd>
86 <dt><span class="memberNameLink"><a href="../edu/uci/iotproject/trafficreassembly/layer3/FinAckPair.html#FinAckPair-org.pcap4j.core.PcapPacket-org.pcap4j.core.PcapPacket-">FinAckPair(PcapPacket, PcapPacket)</a></span> - Constructor for class edu.uci.iotproject.trafficreassembly.layer3.<a href="../edu/uci/iotproject/trafficreassembly/layer3/FinAckPair.html" title="class in edu.uci.iotproject.trafficreassembly.layer3">FinAckPair</a></dt>
87 <dd>
88 <div class="block">Constructs a <code>FinAckPair</code> given a FIN and an ACK packet.</div>
89 </dd>
90 <dt><span class="memberNameLink"><a href="../edu/uci/iotproject/maclayer/MacLayerFlowPatternFinder.html#findFlowPattern--">findFlowPattern()</a></span> - Method in class edu.uci.iotproject.maclayer.<a href="../edu/uci/iotproject/maclayer/MacLayerFlowPatternFinder.html" title="class in edu.uci.iotproject.maclayer">MacLayerFlowPatternFinder</a></dt>
91 <dd>&nbsp;</dd>
92 <dt><a href="../edu/uci/iotproject/FlowPattern.html" title="class in edu.uci.iotproject"><span class="typeNameLink">FlowPattern</span></a> - Class in <a href="../edu/uci/iotproject/package-summary.html">edu.uci.iotproject</a></dt>
93 <dd>
94 <div class="block">TODO add class documentation.</div>
95 </dd>
96 <dt><span class="memberNameLink"><a href="../edu/uci/iotproject/FlowPattern.html#FlowPattern-java.lang.String-java.lang.String-org.pcap4j.core.PcapHandle-">FlowPattern(String, String, PcapHandle)</a></span> - Constructor for class edu.uci.iotproject.<a href="../edu/uci/iotproject/FlowPattern.html" title="class in edu.uci.iotproject">FlowPattern</a></dt>
97 <dd>
98 <div class="block">Constructor #1</div>
99 </dd>
100 <dt><span class="memberNameLink"><a href="../edu/uci/iotproject/FlowPattern.html#FlowPattern-java.lang.String-java.util.List-org.pcap4j.core.PcapHandle-">FlowPattern(String, List&lt;String&gt;, PcapHandle)</a></span> - Constructor for class edu.uci.iotproject.<a href="../edu/uci/iotproject/FlowPattern.html" title="class in edu.uci.iotproject">FlowPattern</a></dt>
101 <dd>
102 <div class="block">Constructor #2</div>
103 </dd>
104 <dt><span class="memberNameLink"><a href="../edu/uci/iotproject/io/LiveCapture.html#fromCliNicSelection-org.pcap4j.core.PacketListener...-">fromCliNicSelection(PacketListener...)</a></span> - Static method in class edu.uci.iotproject.io.<a href="../edu/uci/iotproject/io/LiveCapture.html" title="class in edu.uci.iotproject.io">LiveCapture</a></dt>
105 <dd>
106 <div class="block">Prompts the user to pick a Network Interface Card (NIC) for which live traffic is to be captured, then creates a
107  <a href="../edu/uci/iotproject/io/PcapHandleReader.html" title="class in edu.uci.iotproject.io"><code>PcapHandleReader</code></a> that is ready to start capturing live traffic from that NIC.</div>
108 </dd>
109 <dt><span class="memberNameLink"><a href="../edu/uci/iotproject/io/LiveCapture.html#fromNic-org.pcap4j.core.PcapNetworkInterface-org.pcap4j.core.PacketListener...-">fromNic(PcapNetworkInterface, PacketListener...)</a></span> - Static method in class edu.uci.iotproject.io.<a href="../edu/uci/iotproject/io/LiveCapture.html" title="class in edu.uci.iotproject.io">LiveCapture</a></dt>
110 <dd>
111 <div class="block">Creates a <a href="../edu/uci/iotproject/io/PcapHandleReader.html" title="class in edu.uci.iotproject.io"><code>PcapHandleReader</code></a> that is ready to start capturing live traffic from the provided Network
112  Interface Card (NIC).</div>
113 </dd>
114 <dt><span class="memberNameLink"><a href="../edu/uci/iotproject/trafficreassembly/layer3/Conversation.html#fromPcapPacket-org.pcap4j.core.PcapPacket-boolean-">fromPcapPacket(PcapPacket, boolean)</a></span> - Static method in class edu.uci.iotproject.trafficreassembly.layer3.<a href="../edu/uci/iotproject/trafficreassembly/layer3/Conversation.html" title="class in edu.uci.iotproject.trafficreassembly.layer3">Conversation</a></dt>
115 <dd>
116 <div class="block">Factory method for creating a <code>Conversation</code> from a <code>PcapPacket</code>.</div>
117 </dd>
118 <dt><span class="memberNameLink"><a href="../edu/uci/iotproject/analysis/UserAction.html#fromString-java.lang.String-">fromString(String)</a></span> - Static method in class edu.uci.iotproject.analysis.<a href="../edu/uci/iotproject/analysis/UserAction.html" title="class in edu.uci.iotproject.analysis">UserAction</a></dt>
119 <dd>
120 <div class="block">Instantiates a <code>UserAction</code> from a string that obeys the format used in <a href="../edu/uci/iotproject/analysis/UserAction.html#toString--"><code>UserAction.toString()</code></a>.</div>
121 </dd>
122 </dl>
123 <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>
124 <!-- ======= START OF BOTTOM NAVBAR ====== -->
125 <div class="bottomNav"><a name="navbar.bottom">
126 <!--   -->
127 </a>
128 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
129 <a name="navbar.bottom.firstrow">
130 <!--   -->
131 </a>
132 <ul class="navList" title="Navigation">
133 <li><a href="../overview-summary.html">Overview</a></li>
134 <li>Package</li>
135 <li>Class</li>
136 <li><a href="../overview-tree.html">Tree</a></li>
137 <li><a href="../deprecated-list.html">Deprecated</a></li>
138 <li class="navBarCell1Rev">Index</li>
139 <li><a href="../help-doc.html">Help</a></li>
140 </ul>
141 </div>
142 <div class="subNav">
143 <ul class="navList">
144 <li><a href="index-4.html">Prev Letter</a></li>
145 <li><a href="index-6.html">Next Letter</a></li>
146 </ul>
147 <ul class="navList">
148 <li><a href="../index.html?index-files/index-5.html" target="_top">Frames</a></li>
149 <li><a href="index-5.html" target="_top">No&nbsp;Frames</a></li>
150 </ul>
151 <ul class="navList" id="allclasses_navbar_bottom">
152 <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
153 </ul>
154 <div>
155 <script type="text/javascript"><!--
156   allClassesLink = document.getElementById("allclasses_navbar_bottom");
157   if(window==top) {
158     allClassesLink.style.display = "block";
159   }
160   else {
161     allClassesLink.style.display = "none";
162   }
163   //-->
164 </script>
165 </div>
166 <a name="skip.navbar.bottom">
167 <!--   -->
168 </a></div>
169 <!-- ======== END OF BOTTOM NAVBAR ======= -->
170 </body>
171 </html>