1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
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>
12 <script type="text/javascript"><!--
14 if (location.href.indexOf('is-external=true') == -1) {
15 parent.document.title="TriggerTrafficExtractor";
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";
29 <div>JavaScript is disabled on your browser.</div>
31 <!-- ========= START OF TOP NAVBAR ======= -->
32 <div class="topNav"><a name="navbar.top">
35 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
36 <a name="navbar.top.firstrow">
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>
51 <li><a href="../../../../edu/uci/iotproject/analysis/TrafficLabeler.html" title="class in edu.uci.iotproject.analysis"><span class="typeNameLink">Prev 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 Class</span></a></li>
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 Frames</a></li>
58 <ul class="navList" id="allclasses_navbar_top">
59 <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
62 <script type="text/javascript"><!--
63 allClassesLink = document.getElementById("allclasses_navbar_top");
65 allClassesLink.style.display = "block";
68 allClassesLink.style.display = "none";
74 <ul class="subNavList">
75 <li>Summary: </li>
76 <li>Nested | </li>
77 <li><a href="#field.summary">Field</a> | </li>
78 <li><a href="#constructor.summary">Constr</a> | </li>
79 <li><a href="#method.summary">Method</a></li>
81 <ul class="subNavList">
82 <li>Detail: </li>
83 <li><a href="#field.detail">Field</a> | </li>
84 <li><a href="#constructor.detail">Constr</a> | </li>
85 <li><a href="#method.detail">Method</a></li>
88 <a name="skip.navbar.top">
91 <!-- ========= END OF TOP NAVBAR ========= -->
92 <!-- ======== START OF CLASS DATA ======== -->
94 <div class="subTitle">edu.uci.iotproject.analysis</div>
95 <h2 title="Class TriggerTrafficExtractor" class="title">Class TriggerTrafficExtractor</h2>
97 <div class="contentContainer">
98 <ul class="inheritance">
99 <li>java.lang.Object</li>
101 <ul class="inheritance">
102 <li>edu.uci.iotproject.analysis.TriggerTrafficExtractor</li>
106 <div class="description">
107 <ul class="blockList">
108 <li class="blockList">
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>
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>
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">
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"> </span></caption>
134 <th class="colFirst" scope="col">Modifier and Type</th>
135 <th class="colLast" scope="col">Field and Description</th>
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> </td>
144 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
145 <ul class="blockList">
146 <li class="blockList"><a name="constructor.summary">
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"> </span></caption>
153 <th class="colOne" scope="col">Constructor and Description</th>
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 pcapFilePath,
157 java.util.List<java.time.Instant> triggerTimes,
158 java.lang.String deviceIp)</code> </td>
163 <!-- ========== METHOD SUMMARY =========== -->
164 <ul class="blockList">
165 <li class="blockList"><a name="method.summary">
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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
172 <th class="colFirst" scope="col">Modifier and Type</th>
173 <th class="colLast" scope="col">Method and Description</th>
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>
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... extractedPacketsConsumers)</code> </td>
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 packet)</code> </td>
191 <ul class="blockList">
192 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
195 <h3>Methods inherited from class java.lang.Object</h3>
196 <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
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">
211 <h3>Field Detail</h3>
212 <a name="INCLUSION_WINDOW_MILLIS">
215 <ul class="blockListLast">
216 <li class="blockList">
217 <h4>INCLUSION_WINDOW_MILLIS</h4>
218 <pre>public static final int INCLUSION_WINDOW_MILLIS</pre>
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>
227 <!-- ========= CONSTRUCTOR DETAIL ======== -->
228 <ul class="blockList">
229 <li class="blockList"><a name="constructor.detail">
232 <h3>Constructor Detail</h3>
233 <a name="TriggerTrafficExtractor-java.lang.String-java.util.List-java.lang.String-">
236 <ul class="blockListLast">
237 <li class="blockList">
238 <h4>TriggerTrafficExtractor</h4>
239 <pre>public TriggerTrafficExtractor(java.lang.String pcapFilePath,
240 java.util.List<java.time.Instant> triggerTimes,
241 java.lang.String deviceIp)
242 throws org.pcap4j.core.PcapNativeException,
243 org.pcap4j.core.NotOpenException</pre>
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>
253 <!-- ============ METHOD DETAIL ========== -->
254 <ul class="blockList">
255 <li class="blockList"><a name="method.detail">
258 <h3>Method Detail</h3>
259 <a name="performExtraction-org.pcap4j.core.PacketListener...-">
262 <ul class="blockList">
263 <li class="blockList">
264 <h4>performExtraction</h4>
265 <pre>public void performExtraction(org.pcap4j.core.PacketListener... extractedPacketsConsumers)
266 throws org.pcap4j.core.PcapNativeException,
267 org.pcap4j.core.NotOpenException,
268 java.util.concurrent.TimeoutException</pre>
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>
277 <a name="getPacketsIncludedCount--">
280 <ul class="blockList">
281 <li class="blockList">
282 <h4>getPacketsIncludedCount</h4>
283 <pre>public long 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>
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>
293 <a name="shouldIncludePacket-org.pcap4j.core.PcapPacket-">
296 <ul class="blockListLast">
297 <li class="blockList">
298 <h4>shouldIncludePacket</h4>
299 <pre>public boolean shouldIncludePacket(org.pcap4j.core.PcapPacket packet)</pre>
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> in interface <code><a href="../../../../edu/uci/iotproject/analysis/PcapPacketFilter.html" title="interface in edu.uci.iotproject.analysis">PcapPacketFilter</a></code></dd>
312 <!-- ========= END OF CLASS DATA ========= -->
313 <!-- ======= START OF BOTTOM NAVBAR ====== -->
314 <div class="bottomNav"><a name="navbar.bottom">
317 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
318 <a name="navbar.bottom.firstrow">
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>
333 <li><a href="../../../../edu/uci/iotproject/analysis/TrafficLabeler.html" title="class in edu.uci.iotproject.analysis"><span class="typeNameLink">Prev 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 Class</span></a></li>
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 Frames</a></li>
340 <ul class="navList" id="allclasses_navbar_bottom">
341 <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
344 <script type="text/javascript"><!--
345 allClassesLink = document.getElementById("allclasses_navbar_bottom");
347 allClassesLink.style.display = "block";
350 allClassesLink.style.display = "none";
356 <ul class="subNavList">
357 <li>Summary: </li>
358 <li>Nested | </li>
359 <li><a href="#field.summary">Field</a> | </li>
360 <li><a href="#constructor.summary">Constr</a> | </li>
361 <li><a href="#method.summary">Method</a></li>
363 <ul class="subNavList">
364 <li>Detail: </li>
365 <li><a href="#field.detail">Field</a> | </li>
366 <li><a href="#constructor.detail">Constr</a> | </li>
367 <li><a href="#method.detail">Method</a></li>
370 <a name="skip.navbar.bottom">
373 <!-- ======== END OF BOTTOM NAVBAR ======= -->