Code/Projects/PacketLevelSignatureExtractor/javadoc/edu/uci/iotproject/analysis/TriggerTrafficExtractor.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:58 PDT 2019 -->
   6 <title>TriggerTrafficExtractor</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="TriggerTrafficExtractor";
  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/analysis/TrafficLabeler.html" title="class in edu.uci.iotproject.analysis"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  52 <li><a href="../../../../edu/uci/iotproject/analysis/UserAction.html" title="class in edu.uci.iotproject.analysis"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  53 </ul>
  54 <ul class="navList">
  55 <li><a href="../../../../index.html?edu/uci/iotproject/analysis/TriggerTrafficExtractor.html" target="_top">Frames</a></li>
  56 <li><a href="TriggerTrafficExtractor.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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.analysis</div>
  95 <h2 title="Class TriggerTrafficExtractor" class="title">Class TriggerTrafficExtractor</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>edu.uci.iotproject.analysis.TriggerTrafficExtractor</li>
 103 </ul>
 104 </li>
 105 </ul>
 106 <div class="description">
 107 <ul class="blockList">
 108 <li class="blockList">
 109 <dl>
 110 <dt>All Implemented Interfaces:</dt>
 111 <dd><a href="../../../../edu/uci/iotproject/analysis/PcapPacketFilter.html" title="interface in edu.uci.iotproject.analysis">PcapPacketFilter</a></dd>
 112 </dl>
 113 <hr>
 114 <br>
 115 <pre>public class <span class="typeNameLabel">TriggerTrafficExtractor</span>
 116 extends java.lang.Object
 117 implements <a href="../../../../edu/uci/iotproject/analysis/PcapPacketFilter.html" title="interface in edu.uci.iotproject.analysis">PcapPacketFilter</a></pre>
 118 <div class="block">TODO add class documentation.</div>
 119 </li>
 120 </ul>
 121 </div>
 122 <div class="summary">
 123 <ul class="blockList">
 124 <li class="blockList">
 125 <!-- =========== FIELD SUMMARY =========== -->
 126 <ul class="blockList">
 127 <li class="blockList"><a name="field.summary">
 128 <!--   -->
 129 </a>
 130 <h3>Field Summary</h3>
 131 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
 132 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
 133 <tr>
 134 <th class="colFirst" scope="col">Modifier and Type</th>
 135 <th class="colLast" scope="col">Field and Description</th>
 136 </tr>
 137 <tr class="altColor">
 138 <td class="colFirst"><code>static int</code></td>
 139 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/TriggerTrafficExtractor.html#INCLUSION_WINDOW_MILLIS">INCLUSION_WINDOW_MILLIS</a></span></code>&nbsp;</td>
 140 </tr>
 141 </table>
 142 </li>
 143 </ul>
 144 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 145 <ul class="blockList">
 146 <li class="blockList"><a name="constructor.summary">
 147 <!--   -->
 148 </a>
 149 <h3>Constructor Summary</h3>
 150 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
 151 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 152 <tr>
 153 <th class="colOne" scope="col">Constructor and Description</th>
 154 </tr>
 155 <tr class="altColor">
 156 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/TriggerTrafficExtractor.html#TriggerTrafficExtractor-java.lang.String-java.util.List-java.lang.String-">TriggerTrafficExtractor</a></span>(java.lang.String&nbsp;pcapFilePath,
 157                        java.util.List&lt;java.time.Instant&gt;&nbsp;triggerTimes,
 158                        java.lang.String&nbsp;deviceIp)</code>&nbsp;</td>
 159 </tr>
 160 </table>
 161 </li>
 162 </ul>
 163 <!-- ========== METHOD SUMMARY =========== -->
 164 <ul class="blockList">
 165 <li class="blockList"><a name="method.summary">
 166 <!--   -->
 167 </a>
 168 <h3>Method Summary</h3>
 169 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 170 <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>
 171 <tr>
 172 <th class="colFirst" scope="col">Modifier and Type</th>
 173 <th class="colLast" scope="col">Method and Description</th>
 174 </tr>
 175 <tr id="i0" class="altColor">
 176 <td class="colFirst"><code>long</code></td>
 177 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/TriggerTrafficExtractor.html#getPacketsIncludedCount--">getPacketsIncludedCount</a></span>()</code>
 178 <div class="block">Return the number of extracted packets (i.e., packets selected for inclusion) as a result of the most recent call
 179  to <a href="../../../../edu/uci/iotproject/analysis/TriggerTrafficExtractor.html#performExtraction-org.pcap4j.core.PacketListener...-"><code>performExtraction(PacketListener...)</code></a>.</div>
 180 </td>
 181 </tr>
 182 <tr id="i1" class="rowColor">
 183 <td class="colFirst"><code>void</code></td>
 184 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/TriggerTrafficExtractor.html#performExtraction-org.pcap4j.core.PacketListener...-">performExtraction</a></span>(org.pcap4j.core.PacketListener...&nbsp;extractedPacketsConsumers)</code>&nbsp;</td>
 185 </tr>
 186 <tr id="i2" class="altColor">
 187 <td class="colFirst"><code>boolean</code></td>
 188 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/uci/iotproject/analysis/TriggerTrafficExtractor.html#shouldIncludePacket-org.pcap4j.core.PcapPacket-">shouldIncludePacket</a></span>(org.pcap4j.core.PcapPacket&nbsp;packet)</code>&nbsp;</td>
 189 </tr>
 190 </table>
 191 <ul class="blockList">
 192 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
 193 <!--   -->
 194 </a>
 195 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
 196 <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
 197 </ul>
 198 </li>
 199 </ul>
 200 </li>
 201 </ul>
 202 </div>
 203 <div class="details">
 204 <ul class="blockList">
 205 <li class="blockList">
 206 <!-- ============ FIELD DETAIL =========== -->
 207 <ul class="blockList">
 208 <li class="blockList"><a name="field.detail">
 209 <!--   -->
 210 </a>
 211 <h3>Field Detail</h3>
 212 <a name="INCLUSION_WINDOW_MILLIS">
 213 <!--   -->
 214 </a>
 215 <ul class="blockListLast">
 216 <li class="blockList">
 217 <h4>INCLUSION_WINDOW_MILLIS</h4>
 218 <pre>public static final&nbsp;int INCLUSION_WINDOW_MILLIS</pre>
 219 <dl>
 220 <dt><span class="seeLabel">See Also:</span></dt>
 221 <dd><a href="../../../../constant-values.html#edu.uci.iotproject.analysis.TriggerTrafficExtractor.INCLUSION_WINDOW_MILLIS">Constant Field Values</a></dd>
 222 </dl>
 223 </li>
 224 </ul>
 225 </li>
 226 </ul>
 227 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 228 <ul class="blockList">
 229 <li class="blockList"><a name="constructor.detail">
 230 <!--   -->
 231 </a>
 232 <h3>Constructor Detail</h3>
 233 <a name="TriggerTrafficExtractor-java.lang.String-java.util.List-java.lang.String-">
 234 <!--   -->
 235 </a>
 236 <ul class="blockListLast">
 237 <li class="blockList">
 238 <h4>TriggerTrafficExtractor</h4>
 239 <pre>public&nbsp;TriggerTrafficExtractor(java.lang.String&nbsp;pcapFilePath,
 240                                java.util.List&lt;java.time.Instant&gt;&nbsp;triggerTimes,
 241                                java.lang.String&nbsp;deviceIp)
 242                         throws org.pcap4j.core.PcapNativeException,
 243                                org.pcap4j.core.NotOpenException</pre>
 244 <dl>
 245 <dt><span class="throwsLabel">Throws:</span></dt>
 246 <dd><code>org.pcap4j.core.PcapNativeException</code></dd>
 247 <dd><code>org.pcap4j.core.NotOpenException</code></dd>
 248 </dl>
 249 </li>
 250 </ul>
 251 </li>
 252 </ul>
 253 <!-- ============ METHOD DETAIL ========== -->
 254 <ul class="blockList">
 255 <li class="blockList"><a name="method.detail">
 256 <!--   -->
 257 </a>
 258 <h3>Method Detail</h3>
 259 <a name="performExtraction-org.pcap4j.core.PacketListener...-">
 260 <!--   -->
 261 </a>
 262 <ul class="blockList">
 263 <li class="blockList">
 264 <h4>performExtraction</h4>
 265 <pre>public&nbsp;void&nbsp;performExtraction(org.pcap4j.core.PacketListener...&nbsp;extractedPacketsConsumers)
 266                        throws org.pcap4j.core.PcapNativeException,
 267                               org.pcap4j.core.NotOpenException,
 268                               java.util.concurrent.TimeoutException</pre>
 269 <dl>
 270 <dt><span class="throwsLabel">Throws:</span></dt>
 271 <dd><code>org.pcap4j.core.PcapNativeException</code></dd>
 272 <dd><code>org.pcap4j.core.NotOpenException</code></dd>
 273 <dd><code>java.util.concurrent.TimeoutException</code></dd>
 274 </dl>
 275 </li>
 276 </ul>
 277 <a name="getPacketsIncludedCount--">
 278 <!--   -->
 279 </a>
 280 <ul class="blockList">
 281 <li class="blockList">
 282 <h4>getPacketsIncludedCount</h4>
 283 <pre>public&nbsp;long&nbsp;getPacketsIncludedCount()</pre>
 284 <div class="block">Return the number of extracted packets (i.e., packets selected for inclusion) as a result of the most recent call
 285  to <a href="../../../../edu/uci/iotproject/analysis/TriggerTrafficExtractor.html#performExtraction-org.pcap4j.core.PacketListener...-"><code>performExtraction(PacketListener...)</code></a>.</div>
 286 <dl>
 287 <dt><span class="returnLabel">Returns:</span></dt>
 288 <dd>the number of extracted packets (i.e., packets selected for inclusion) as a result of the most recent
 289          call to <a href="../../../../edu/uci/iotproject/analysis/TriggerTrafficExtractor.html#performExtraction-org.pcap4j.core.PacketListener...-"><code>performExtraction(PacketListener...)</code></a>.</dd>
 290 </dl>
 291 </li>
 292 </ul>
 293 <a name="shouldIncludePacket-org.pcap4j.core.PcapPacket-">
 294 <!--   -->
 295 </a>
 296 <ul class="blockListLast">
 297 <li class="blockList">
 298 <h4>shouldIncludePacket</h4>
 299 <pre>public&nbsp;boolean&nbsp;shouldIncludePacket(org.pcap4j.core.PcapPacket&nbsp;packet)</pre>
 300 <dl>
 301 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 302 <dd><code><a href="../../../../edu/uci/iotproject/analysis/PcapPacketFilter.html#shouldIncludePacket-org.pcap4j.core.PcapPacket-">shouldIncludePacket</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../edu/uci/iotproject/analysis/PcapPacketFilter.html" title="interface in edu.uci.iotproject.analysis">PcapPacketFilter</a></code></dd>
 303 </dl>
 304 </li>
 305 </ul>
 306 </li>
 307 </ul>
 308 </li>
 309 </ul>
 310 </div>
 311 </div>
 312 <!-- ========= END OF CLASS DATA ========= -->
 313 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 314 <div class="bottomNav"><a name="navbar.bottom">
 315 <!--   -->
 316 </a>
 317 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 318 <a name="navbar.bottom.firstrow">
 319 <!--   -->
 320 </a>
 321 <ul class="navList" title="Navigation">
 322 <li><a href="../../../../overview-summary.html">Overview</a></li>
 323 <li><a href="package-summary.html">Package</a></li>
 324 <li class="navBarCell1Rev">Class</li>
 325 <li><a href="package-tree.html">Tree</a></li>
 326 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 327 <li><a href="../../../../index-files/index-1.html">Index</a></li>
 328 <li><a href="../../../../help-doc.html">Help</a></li>
 329 </ul>
 330 </div>
 331 <div class="subNav">
 332 <ul class="navList">
 333 <li><a href="../../../../edu/uci/iotproject/analysis/TrafficLabeler.html" title="class in edu.uci.iotproject.analysis"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 334 <li><a href="../../../../edu/uci/iotproject/analysis/UserAction.html" title="class in edu.uci.iotproject.analysis"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 335 </ul>
 336 <ul class="navList">
 337 <li><a href="../../../../index.html?edu/uci/iotproject/analysis/TriggerTrafficExtractor.html" target="_top">Frames</a></li>
 338 <li><a href="TriggerTrafficExtractor.html" target="_top">No&nbsp;Frames</a></li>
 339 </ul>
 340 <ul class="navList" id="allclasses_navbar_bottom">
 341 <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 342 </ul>
 343 <div>
 344 <script type="text/javascript"><!--
 345   allClassesLink = document.getElementById("allclasses_navbar_bottom");
 346   if(window==top) {
 347     allClassesLink.style.display = "block";
 348   }
 349   else {
 350     allClassesLink.style.display = "none";
 351   }
 352   //-->
 353 </script>
 354 </div>
 355 <div>
 356 <ul class="subNavList">
 357 <li>Summary:&nbsp;</li>
 358 <li>Nested&nbsp;|&nbsp;</li>
 359 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
 360 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 361 <li><a href="#method.summary">Method</a></li>
 362 </ul>
 363 <ul class="subNavList">
 364 <li>Detail:&nbsp;</li>
 365 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 366 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 367 <li><a href="#method.detail">Method</a></li>
 368 </ul>
 369 </div>
 370 <a name="skip.navbar.bottom">
 371 <!--   -->
 372 </a></div>
 373 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 374 </body>
 375 </html>