Code/Projects/PacketLevelSignatureExtractor/javadoc/edu/uci/iotproject/detection/layer2/Layer2SequenceMatcher.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>Layer2SequenceMatcher</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="Layer2SequenceMatcher";
  16         }
  17     }
  18     catch(err) {
  19     }
  20 //-->
  21 var methods = {"i0":10,"i1":10,"i2":10};
  22 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/layer2/Layer2RangeMatcher.html" title="class in edu.uci.iotproject.detection.layer2"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  52 <li><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2SignatureDetector.html" title="class in edu.uci.iotproject.detection.layer2"><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/layer2/Layer2SequenceMatcher.html" target="_top">Frames</a></li>
  56 <li><a href="Layer2SequenceMatcher.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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.layer2</div>
  95 <h2 title="Class Layer2SequenceMatcher" class="title">Class Layer2SequenceMatcher</h2>
  96 </div>
  97 <div class="contentContainer">
  98 <ul class="inheritance">
  99 <li>java.lang.Object</li>
 100 <li>
 101 <ul class="inheritance">
 102 <li><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2AbstractMatcher.html" title="class in edu.uci.iotproject.detection.layer2">edu.uci.iotproject.detection.layer2.Layer2AbstractMatcher</a></li>
 103 <li>
 104 <ul class="inheritance">
 105 <li>edu.uci.iotproject.detection.layer2.Layer2SequenceMatcher</li>
 106 </ul>
 107 </li>
 108 </ul>
 109 </li>
 110 </ul>
 111 <div class="description">
 112 <ul class="blockList">
 113 <li class="blockList">
 114 <hr>
 115 <br>
 116 <pre>public class <span class="typeNameLabel">Layer2SequenceMatcher</span>
 117 extends <a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2AbstractMatcher.html" title="class in edu.uci.iotproject.detection.layer2">Layer2AbstractMatcher</a></pre>
 118 <div class="block">Attempts to detect the presence of a specific packet sequence in the set of packets provided through multiple calls
 119  to <a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2SequenceMatcher.html#matchPacket-org.pcap4j.core.PcapPacket-"><code>matchPacket(PcapPacket)</code></a>, considering only layer 2 information.</div>
 120 </li>
 121 </ul>
 122 </div>
 123 <div class="summary">
 124 <ul class="blockList">
 125 <li class="blockList">
 126 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 127 <ul class="blockList">
 128 <li class="blockList"><a name="constructor.summary">
 129 <!--   -->
 130 </a>
 131 <h3>Constructor Summary</h3>
 132 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
 133 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 134 <tr>
 135 <th class="colOne" scope="col">Constructor and Description</th>
 136 </tr>
 137 <tr class="altColor">
 138 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2SequenceMatcher.html#Layer2SequenceMatcher-java.util.List-int-">Layer2SequenceMatcher</a></span>(java.util.List&lt;org.pcap4j.core.PcapPacket&gt;&nbsp;sequence,
 139                      int&nbsp;inclusionTimeMillis)</code>
 140 <div class="block">Create a <code>Layer2SequenceMatcher</code>.</div>
 141 </td>
 142 </tr>
 143 </table>
 144 </li>
 145 </ul>
 146 <!-- ========== METHOD SUMMARY =========== -->
 147 <ul class="blockList">
 148 <li class="blockList"><a name="method.summary">
 149 <!--   -->
 150 </a>
 151 <h3>Method Summary</h3>
 152 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 153 <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>
 154 <tr>
 155 <th class="colFirst" scope="col">Modifier and Type</th>
 156 <th class="colLast" scope="col">Method and Description</th>
 157 </tr>
 158 <tr id="i0" class="altColor">
 159 <td class="colFirst"><code>java.util.List&lt;org.pcap4j.core.PcapPacket&gt;</code></td>
 160 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2SequenceMatcher.html#getTargetSequence--">getTargetSequence</a></span>()</code>&nbsp;</td>
 161 </tr>
 162 <tr id="i1" class="rowColor">
 163 <td class="colFirst"><code>int</code></td>
 164 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2SequenceMatcher.html#getTargetSequencePacketCount--">getTargetSequencePacketCount</a></span>()</code>
 165 <div class="block">See the implementer class for the following method.</div>
 166 </td>
 167 </tr>
 168 <tr id="i2" class="altColor">
 169 <td class="colFirst"><code>boolean</code></td>
 170 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2SequenceMatcher.html#matchPacket-org.pcap4j.core.PcapPacket-">matchPacket</a></span>(org.pcap4j.core.PcapPacket&nbsp;packet)</code>
 171 <div class="block">Attempt to advance this <code>Layer2SequenceMatcher</code> by matching <code>packet</code> against the packet that this
 172  <code>Layer2SequenceMatcher</code> expects as the next packet of the sequence it is searching for.</div>
 173 </td>
 174 </tr>
 175 </table>
 176 <ul class="blockList">
 177 <li class="blockList"><a name="methods.inherited.from.class.edu.uci.iotproject.detection.layer2.Layer2AbstractMatcher">
 178 <!--   -->
 179 </a>
 180 <h3>Methods inherited from class&nbsp;edu.uci.iotproject.detection.layer2.<a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2AbstractMatcher.html" title="class in edu.uci.iotproject.detection.layer2">Layer2AbstractMatcher</a></h3>
 181 <code><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2AbstractMatcher.html#getLastPacket--">getLastPacket</a>, <a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2AbstractMatcher.html#getMatchedPackets--">getMatchedPackets</a>, <a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2AbstractMatcher.html#getMatchedPacketsCount--">getMatchedPacketsCount</a></code></li>
 182 </ul>
 183 <ul class="blockList">
 184 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
 185 <!--   -->
 186 </a>
 187 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
 188 <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
 189 </ul>
 190 </li>
 191 </ul>
 192 </li>
 193 </ul>
 194 </div>
 195 <div class="details">
 196 <ul class="blockList">
 197 <li class="blockList">
 198 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 199 <ul class="blockList">
 200 <li class="blockList"><a name="constructor.detail">
 201 <!--   -->
 202 </a>
 203 <h3>Constructor Detail</h3>
 204 <a name="Layer2SequenceMatcher-java.util.List-int-">
 205 <!--   -->
 206 </a>
 207 <ul class="blockListLast">
 208 <li class="blockList">
 209 <h4>Layer2SequenceMatcher</h4>
 210 <pre>public&nbsp;Layer2SequenceMatcher(java.util.List&lt;org.pcap4j.core.PcapPacket&gt;&nbsp;sequence,
 211                              int&nbsp;inclusionTimeMillis)</pre>
 212 <div class="block">Create a <code>Layer2SequenceMatcher</code>.</div>
 213 <dl>
 214 <dt><span class="paramLabel">Parameters:</span></dt>
 215 <dd><code>sequence</code> - The sequence to match against (search for).</dd>
 216 </dl>
 217 </li>
 218 </ul>
 219 </li>
 220 </ul>
 221 <!-- ============ METHOD DETAIL ========== -->
 222 <ul class="blockList">
 223 <li class="blockList"><a name="method.detail">
 224 <!--   -->
 225 </a>
 226 <h3>Method Detail</h3>
 227 <a name="matchPacket-org.pcap4j.core.PcapPacket-">
 228 <!--   -->
 229 </a>
 230 <ul class="blockList">
 231 <li class="blockList">
 232 <h4>matchPacket</h4>
 233 <pre>public&nbsp;boolean&nbsp;matchPacket(org.pcap4j.core.PcapPacket&nbsp;packet)</pre>
 234 <div class="block">Attempt to advance this <code>Layer2SequenceMatcher</code> by matching <code>packet</code> against the packet that this
 235  <code>Layer2SequenceMatcher</code> expects as the next packet of the sequence it is searching for.</div>
 236 <dl>
 237 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 238 <dd><code><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2AbstractMatcher.html#matchPacket-org.pcap4j.core.PcapPacket-">matchPacket</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2AbstractMatcher.html" title="class in edu.uci.iotproject.detection.layer2">Layer2AbstractMatcher</a></code></dd>
 239 <dt><span class="paramLabel">Parameters:</span></dt>
 240 <dd><code>packet</code> - </dd>
 241 <dt><span class="returnLabel">Returns:</span></dt>
 242 <dd><code>true</code> if this <code>Layer2SequenceMatcher</code> could advance by adding <code>packet</code> to its set of
 243          matched packets, <code>false</code> otherwise.</dd>
 244 </dl>
 245 </li>
 246 </ul>
 247 <a name="getTargetSequencePacketCount--">
 248 <!--   -->
 249 </a>
 250 <ul class="blockList">
 251 <li class="blockList">
 252 <h4>getTargetSequencePacketCount</h4>
 253 <pre>public&nbsp;int&nbsp;getTargetSequencePacketCount()</pre>
 254 <div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2AbstractMatcher.html#getTargetSequencePacketCount--">Layer2AbstractMatcher</a></code></span></div>
 255 <div class="block">See the implementer class for the following method.</div>
 256 <dl>
 257 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 258 <dd><code><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2AbstractMatcher.html#getTargetSequencePacketCount--">getTargetSequencePacketCount</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2AbstractMatcher.html" title="class in edu.uci.iotproject.detection.layer2">Layer2AbstractMatcher</a></code></dd>
 259 </dl>
 260 </li>
 261 </ul>
 262 <a name="getTargetSequence--">
 263 <!--   -->
 264 </a>
 265 <ul class="blockListLast">
 266 <li class="blockList">
 267 <h4>getTargetSequence</h4>
 268 <pre>public&nbsp;java.util.List&lt;org.pcap4j.core.PcapPacket&gt;&nbsp;getTargetSequence()</pre>
 269 </li>
 270 </ul>
 271 </li>
 272 </ul>
 273 </li>
 274 </ul>
 275 </div>
 276 </div>
 277 <!-- ========= END OF CLASS DATA ========= -->
 278 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 279 <div class="bottomNav"><a name="navbar.bottom">
 280 <!--   -->
 281 </a>
 282 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 283 <a name="navbar.bottom.firstrow">
 284 <!--   -->
 285 </a>
 286 <ul class="navList" title="Navigation">
 287 <li><a href="../../../../../overview-summary.html">Overview</a></li>
 288 <li><a href="package-summary.html">Package</a></li>
 289 <li class="navBarCell1Rev">Class</li>
 290 <li><a href="package-tree.html">Tree</a></li>
 291 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
 292 <li><a href="../../../../../index-files/index-1.html">Index</a></li>
 293 <li><a href="../../../../../help-doc.html">Help</a></li>
 294 </ul>
 295 </div>
 296 <div class="subNav">
 297 <ul class="navList">
 298 <li><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2RangeMatcher.html" title="class in edu.uci.iotproject.detection.layer2"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 299 <li><a href="../../../../../edu/uci/iotproject/detection/layer2/Layer2SignatureDetector.html" title="class in edu.uci.iotproject.detection.layer2"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 300 </ul>
 301 <ul class="navList">
 302 <li><a href="../../../../../index.html?edu/uci/iotproject/detection/layer2/Layer2SequenceMatcher.html" target="_top">Frames</a></li>
 303 <li><a href="Layer2SequenceMatcher.html" target="_top">No&nbsp;Frames</a></li>
 304 </ul>
 305 <ul class="navList" id="allclasses_navbar_bottom">
 306 <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 307 </ul>
 308 <div>
 309 <script type="text/javascript"><!--
 310   allClassesLink = document.getElementById("allclasses_navbar_bottom");
 311   if(window==top) {
 312     allClassesLink.style.display = "block";
 313   }
 314   else {
 315     allClassesLink.style.display = "none";
 316   }
 317   //-->
 318 </script>
 319 </div>
 320 <div>
 321 <ul class="subNavList">
 322 <li>Summary:&nbsp;</li>
 323 <li>Nested&nbsp;|&nbsp;</li>
 324 <li>Field&nbsp;|&nbsp;</li>
 325 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 326 <li><a href="#method.summary">Method</a></li>
 327 </ul>
 328 <ul class="subNavList">
 329 <li>Detail:&nbsp;</li>
 330 <li>Field&nbsp;|&nbsp;</li>
 331 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 332 <li><a href="#method.detail">Method</a></li>
 333 </ul>
 334 </div>
 335 <a name="skip.navbar.bottom">
 336 <!--   -->
 337 </a></div>
 338 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 339 </body>
 340 </html>