Adding Javadoc documentation.
[pingpong.git] / Code / Projects / PacketLevelSignatureExtractor / javadoc / edu / uci / iotproject / detection / SignatureDetectorObserver.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:59 PDT 2019 -->
6 <title>SignatureDetectorObserver</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="SignatureDetectorObserver";
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/detection/ClusterMatcherObserver.html" title="interface in edu.uci.iotproject.detection"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
52 <li>Next&nbsp;Class</li>
53 </ul>
54 <ul class="navList">
55 <li><a href="../../../../index.html?edu/uci/iotproject/detection/SignatureDetectorObserver.html" target="_top">Frames</a></li>
56 <li><a href="SignatureDetectorObserver.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.detection</div>
95 <h2 title="Interface SignatureDetectorObserver" class="title">Interface SignatureDetectorObserver</h2>
96 </div>
97 <div class="contentContainer">
98 <div class="description">
99 <ul class="blockList">
100 <li class="blockList">
101 <hr>
102 <br>
103 <pre>public interface <span class="typeNameLabel">SignatureDetectorObserver</span></pre>
104 <div class="block">Used for registering for notifications from a signature detector.</div>
105 </li>
106 </ul>
107 </div>
108 <div class="summary">
109 <ul class="blockList">
110 <li class="blockList">
111 <!-- ========== METHOD SUMMARY =========== -->
112 <ul class="blockList">
113 <li class="blockList"><a name="method.summary">
114 <!--   -->
115 </a>
116 <h3>Method Summary</h3>
117 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
118 <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>
119 <tr>
120 <th class="colFirst" scope="col">Modifier and Type</th>
121 <th class="colLast" scope="col">Method and Description</th>
122 </tr>
123 <tr id="i0" class="altColor">
124 <td class="colFirst"><code>void</code></td>
125 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/detection/SignatureDetectorObserver.html#onSignatureDetected-java.util.List-java.util.List-">onSignatureDetected</a></span>(java.util.List&lt;java.util.List&lt;java.util.List&lt;org.pcap4j.core.PcapPacket&gt;&gt;&gt;&nbsp;searchedSignature,
126                    java.util.List&lt;java.util.List&lt;org.pcap4j.core.PcapPacket&gt;&gt;&nbsp;matchingTraffic)</code>
127 <div class="block">Invoked when the signature detector has detected the presence of a signature in the traffic that it's examining.</div>
128 </td>
129 </tr>
130 </table>
131 </li>
132 </ul>
133 </li>
134 </ul>
135 </div>
136 <div class="details">
137 <ul class="blockList">
138 <li class="blockList">
139 <!-- ============ METHOD DETAIL ========== -->
140 <ul class="blockList">
141 <li class="blockList"><a name="method.detail">
142 <!--   -->
143 </a>
144 <h3>Method Detail</h3>
145 <a name="onSignatureDetected-java.util.List-java.util.List-">
146 <!--   -->
147 </a>
148 <ul class="blockListLast">
149 <li class="blockList">
150 <h4>onSignatureDetected</h4>
151 <pre>void&nbsp;onSignatureDetected(java.util.List&lt;java.util.List&lt;java.util.List&lt;org.pcap4j.core.PcapPacket&gt;&gt;&gt;&nbsp;searchedSignature,
152                          java.util.List&lt;java.util.List&lt;org.pcap4j.core.PcapPacket&gt;&gt;&nbsp;matchingTraffic)</pre>
153 <div class="block">Invoked when the signature detector has detected the presence of a signature in the traffic that it's examining.</div>
154 <dl>
155 <dt><span class="paramLabel">Parameters:</span></dt>
156 <dd><code>searchedSignature</code> - The signature that the signature detector reporting the match is searching for.</dd>
157 <dd><code>matchingTraffic</code> - The actual traffic trace that matches the searched signature.</dd>
158 </dl>
159 </li>
160 </ul>
161 </li>
162 </ul>
163 </li>
164 </ul>
165 </div>
166 </div>
167 <!-- ========= END OF CLASS DATA ========= -->
168 <!-- ======= START OF BOTTOM NAVBAR ====== -->
169 <div class="bottomNav"><a name="navbar.bottom">
170 <!--   -->
171 </a>
172 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
173 <a name="navbar.bottom.firstrow">
174 <!--   -->
175 </a>
176 <ul class="navList" title="Navigation">
177 <li><a href="../../../../overview-summary.html">Overview</a></li>
178 <li><a href="package-summary.html">Package</a></li>
179 <li class="navBarCell1Rev">Class</li>
180 <li><a href="package-tree.html">Tree</a></li>
181 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
182 <li><a href="../../../../index-files/index-1.html">Index</a></li>
183 <li><a href="../../../../help-doc.html">Help</a></li>
184 </ul>
185 </div>
186 <div class="subNav">
187 <ul class="navList">
188 <li><a href="../../../../edu/uci/iotproject/detection/ClusterMatcherObserver.html" title="interface in edu.uci.iotproject.detection"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
189 <li>Next&nbsp;Class</li>
190 </ul>
191 <ul class="navList">
192 <li><a href="../../../../index.html?edu/uci/iotproject/detection/SignatureDetectorObserver.html" target="_top">Frames</a></li>
193 <li><a href="SignatureDetectorObserver.html" target="_top">No&nbsp;Frames</a></li>
194 </ul>
195 <ul class="navList" id="allclasses_navbar_bottom">
196 <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
197 </ul>
198 <div>
199 <script type="text/javascript"><!--
200   allClassesLink = document.getElementById("allclasses_navbar_bottom");
201   if(window==top) {
202     allClassesLink.style.display = "block";
203   }
204   else {
205     allClassesLink.style.display = "none";
206   }
207   //-->
208 </script>
209 </div>
210 <div>
211 <ul class="subNavList">
212 <li>Summary:&nbsp;</li>
213 <li>Nested&nbsp;|&nbsp;</li>
214 <li>Field&nbsp;|&nbsp;</li>
215 <li>Constr&nbsp;|&nbsp;</li>
216 <li><a href="#method.summary">Method</a></li>
217 </ul>
218 <ul class="subNavList">
219 <li>Detail:&nbsp;</li>
220 <li>Field&nbsp;|&nbsp;</li>
221 <li>Constr&nbsp;|&nbsp;</li>
222 <li><a href="#method.detail">Method</a></li>
223 </ul>
224 </div>
225 <a name="skip.navbar.bottom">
226 <!--   -->
227 </a></div>
228 <!-- ======== END OF BOTTOM NAVBAR ======= -->
229 </body>
230 </html>