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