Code/Projects/PacketLevelSignatureExtractor/javadoc/edu/uci/iotproject/trafficreassembly/layer3/FinAckPair.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>FinAckPair</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="FinAckPair";
  16         }
  17     }
  18     catch(err) {
  19     }
  20 //-->
  21 var methods = {"i0":10,"i1":10,"i2":10,"i3":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/trafficreassembly/layer3/Conversation.Direction.html" title="enum in edu.uci.iotproject.trafficreassembly.layer3"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  52 <li><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/TcpReassembler.html" title="class in edu.uci.iotproject.trafficreassembly.layer3"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  53 </ul>
  54 <ul class="navList">
  55 <li><a href="../../../../../index.html?edu/uci/iotproject/trafficreassembly/layer3/FinAckPair.html" target="_top">Frames</a></li>
  56 <li><a href="FinAckPair.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.trafficreassembly.layer3</div>
  95 <h2 title="Class FinAckPair" class="title">Class FinAckPair</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.trafficreassembly.layer3.FinAckPair</li>
 103 </ul>
 104 </li>
 105 </ul>
 106 <div class="description">
 107 <ul class="blockList">
 108 <li class="blockList">
 109 <hr>
 110 <br>
 111 <pre>public class <span class="typeNameLabel">FinAckPair</span>
 112 extends java.lang.Object</pre>
 113 <div class="block">Groups a FIN packet and its corresponding ACK packet. <b>Immutable and thread safe</b>.</div>
 114 </li>
 115 </ul>
 116 </div>
 117 <div class="summary">
 118 <ul class="blockList">
 119 <li class="blockList">
 120 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 121 <ul class="blockList">
 122 <li class="blockList"><a name="constructor.summary">
 123 <!--   -->
 124 </a>
 125 <h3>Constructor Summary</h3>
 126 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
 127 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 128 <tr>
 129 <th class="colOne" scope="col">Constructor and Description</th>
 130 </tr>
 131 <tr class="altColor">
 132 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/FinAckPair.html#FinAckPair-org.pcap4j.core.PcapPacket-">FinAckPair</a></span>(org.pcap4j.core.PcapPacket&nbsp;finPacket)</code>
 133 <div class="block">Constructs a <code>FinAckPair</code> given a FIN packet.</div>
 134 </td>
 135 </tr>
 136 <tr class="rowColor">
 137 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/FinAckPair.html#FinAckPair-org.pcap4j.core.PcapPacket-org.pcap4j.core.PcapPacket-">FinAckPair</a></span>(org.pcap4j.core.PcapPacket&nbsp;finPacket,
 138           org.pcap4j.core.PcapPacket&nbsp;correspondingAckPacket)</code>
 139 <div class="block">Constructs a <code>FinAckPair</code> given a FIN and an ACK packet.</div>
 140 </td>
 141 </tr>
 142 </table>
 143 </li>
 144 </ul>
 145 <!-- ========== METHOD SUMMARY =========== -->
 146 <ul class="blockList">
 147 <li class="blockList"><a name="method.summary">
 148 <!--   -->
 149 </a>
 150 <h3>Method Summary</h3>
 151 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 152 <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>
 153 <tr>
 154 <th class="colFirst" scope="col">Modifier and Type</th>
 155 <th class="colLast" scope="col">Method and Description</th>
 156 </tr>
 157 <tr id="i0" class="altColor">
 158 <td class="colFirst"><code>org.pcap4j.core.PcapPacket</code></td>
 159 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/FinAckPair.html#getCorrespondingAckPacket--">getCorrespondingAckPacket</a></span>()</code>
 160 <div class="block">Get the corresponding ACK packet of this pair, if any.</div>
 161 </td>
 162 </tr>
 163 <tr id="i1" class="rowColor">
 164 <td class="colFirst"><code>org.pcap4j.core.PcapPacket</code></td>
 165 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/FinAckPair.html#getFinPacket--">getFinPacket</a></span>()</code>
 166 <div class="block">Get the FIN packet of this pair.</div>
 167 </td>
 168 </tr>
 169 <tr id="i2" class="altColor">
 170 <td class="colFirst"><code>boolean</code></td>
 171 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/FinAckPair.html#isAcknowledged--">isAcknowledged</a></span>()</code>
 172 <div class="block">Was the FIN in this <code>FinAckPair</code> acknowledged?</div>
 173 </td>
 174 </tr>
 175 <tr id="i3" class="rowColor">
 176 <td class="colFirst"><code>boolean</code></td>
 177 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/FinAckPair.html#isCorrespondingAckPacket-org.pcap4j.core.PcapPacket-">isCorrespondingAckPacket</a></span>(org.pcap4j.core.PcapPacket&nbsp;packet)</code>
 178 <div class="block">Checks if a given packet is an ACK corresponding to the FIN packet in this <code>FinAckPair</code>.</div>
 179 </td>
 180 </tr>
 181 </table>
 182 <ul class="blockList">
 183 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
 184 <!--   -->
 185 </a>
 186 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
 187 <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
 188 </ul>
 189 </li>
 190 </ul>
 191 </li>
 192 </ul>
 193 </div>
 194 <div class="details">
 195 <ul class="blockList">
 196 <li class="blockList">
 197 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 198 <ul class="blockList">
 199 <li class="blockList"><a name="constructor.detail">
 200 <!--   -->
 201 </a>
 202 <h3>Constructor Detail</h3>
 203 <a name="FinAckPair-org.pcap4j.core.PcapPacket-">
 204 <!--   -->
 205 </a>
 206 <ul class="blockList">
 207 <li class="blockList">
 208 <h4>FinAckPair</h4>
 209 <pre>public&nbsp;FinAckPair(org.pcap4j.core.PcapPacket&nbsp;finPacket)</pre>
 210 <div class="block">Constructs a <code>FinAckPair</code> given a FIN packet.
 211  The corresponding ACK packet field is set to <code>null</code>.</div>
 212 <dl>
 213 <dt><span class="paramLabel">Parameters:</span></dt>
 214 <dd><code>finPacket</code> - A FIN packet.</dd>
 215 </dl>
 216 </li>
 217 </ul>
 218 <a name="FinAckPair-org.pcap4j.core.PcapPacket-org.pcap4j.core.PcapPacket-">
 219 <!--   -->
 220 </a>
 221 <ul class="blockListLast">
 222 <li class="blockList">
 223 <h4>FinAckPair</h4>
 224 <pre>public&nbsp;FinAckPair(org.pcap4j.core.PcapPacket&nbsp;finPacket,
 225                   org.pcap4j.core.PcapPacket&nbsp;correspondingAckPacket)</pre>
 226 <div class="block">Constructs a <code>FinAckPair</code> given a FIN and an ACK packet.</div>
 227 <dl>
 228 <dt><span class="paramLabel">Parameters:</span></dt>
 229 <dd><code>finPacket</code> - A FIN packet.</dd>
 230 <dd><code>correspondingAckPacket</code> - The ACK packet corresponding to <code>finPacket</code>.</dd>
 231 </dl>
 232 </li>
 233 </ul>
 234 </li>
 235 </ul>
 236 <!-- ============ METHOD DETAIL ========== -->
 237 <ul class="blockList">
 238 <li class="blockList"><a name="method.detail">
 239 <!--   -->
 240 </a>
 241 <h3>Method Detail</h3>
 242 <a name="getFinPacket--">
 243 <!--   -->
 244 </a>
 245 <ul class="blockList">
 246 <li class="blockList">
 247 <h4>getFinPacket</h4>
 248 <pre>public&nbsp;org.pcap4j.core.PcapPacket&nbsp;getFinPacket()</pre>
 249 <div class="block">Get the FIN packet of this pair.</div>
 250 <dl>
 251 <dt><span class="returnLabel">Returns:</span></dt>
 252 <dd>the FIN packet of this pair.</dd>
 253 </dl>
 254 </li>
 255 </ul>
 256 <a name="getCorrespondingAckPacket--">
 257 <!--   -->
 258 </a>
 259 <ul class="blockList">
 260 <li class="blockList">
 261 <h4>getCorrespondingAckPacket</h4>
 262 <pre>public&nbsp;org.pcap4j.core.PcapPacket&nbsp;getCorrespondingAckPacket()</pre>
 263 <div class="block">Get the corresponding ACK packet of this pair, if any.</div>
 264 <dl>
 265 <dt><span class="returnLabel">Returns:</span></dt>
 266 <dd>the corresponding ACK packet of this pair, if any.</dd>
 267 </dl>
 268 </li>
 269 </ul>
 270 <a name="isAcknowledged--">
 271 <!--   -->
 272 </a>
 273 <ul class="blockList">
 274 <li class="blockList">
 275 <h4>isAcknowledged</h4>
 276 <pre>public&nbsp;boolean&nbsp;isAcknowledged()</pre>
 277 <div class="block">Was the FIN in this <code>FinAckPair</code> acknowledged?</div>
 278 <dl>
 279 <dt><span class="returnLabel">Returns:</span></dt>
 280 <dd><code>true</code> if the corresponding ACK has been set in this <code>FinAckPair</code>.</dd>
 281 </dl>
 282 </li>
 283 </ul>
 284 <a name="isCorrespondingAckPacket-org.pcap4j.core.PcapPacket-">
 285 <!--   -->
 286 </a>
 287 <ul class="blockListLast">
 288 <li class="blockList">
 289 <h4>isCorrespondingAckPacket</h4>
 290 <pre>public&nbsp;boolean&nbsp;isCorrespondingAckPacket(org.pcap4j.core.PcapPacket&nbsp;packet)</pre>
 291 <div class="block">Checks if a given packet is an ACK corresponding to the FIN packet in this <code>FinAckPair</code>.</div>
 292 <dl>
 293 <dt><span class="returnLabel">Returns:</span></dt>
 294 <dd><code>true</code> if <code>packet</code> is an ACK that corresponds to the FIN in this pair, <code>false</code> otherwise.</dd>
 295 </dl>
 296 </li>
 297 </ul>
 298 </li>
 299 </ul>
 300 </li>
 301 </ul>
 302 </div>
 303 </div>
 304 <!-- ========= END OF CLASS DATA ========= -->
 305 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 306 <div class="bottomNav"><a name="navbar.bottom">
 307 <!--   -->
 308 </a>
 309 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 310 <a name="navbar.bottom.firstrow">
 311 <!--   -->
 312 </a>
 313 <ul class="navList" title="Navigation">
 314 <li><a href="../../../../../overview-summary.html">Overview</a></li>
 315 <li><a href="package-summary.html">Package</a></li>
 316 <li class="navBarCell1Rev">Class</li>
 317 <li><a href="package-tree.html">Tree</a></li>
 318 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
 319 <li><a href="../../../../../index-files/index-1.html">Index</a></li>
 320 <li><a href="../../../../../help-doc.html">Help</a></li>
 321 </ul>
 322 </div>
 323 <div class="subNav">
 324 <ul class="navList">
 325 <li><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/Conversation.Direction.html" title="enum in edu.uci.iotproject.trafficreassembly.layer3"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 326 <li><a href="../../../../../edu/uci/iotproject/trafficreassembly/layer3/TcpReassembler.html" title="class in edu.uci.iotproject.trafficreassembly.layer3"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 327 </ul>
 328 <ul class="navList">
 329 <li><a href="../../../../../index.html?edu/uci/iotproject/trafficreassembly/layer3/FinAckPair.html" target="_top">Frames</a></li>
 330 <li><a href="FinAckPair.html" target="_top">No&nbsp;Frames</a></li>
 331 </ul>
 332 <ul class="navList" id="allclasses_navbar_bottom">
 333 <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 334 </ul>
 335 <div>
 336 <script type="text/javascript"><!--
 337   allClassesLink = document.getElementById("allclasses_navbar_bottom");
 338   if(window==top) {
 339     allClassesLink.style.display = "block";
 340   }
 341   else {
 342     allClassesLink.style.display = "none";
 343   }
 344   //-->
 345 </script>
 346 </div>
 347 <div>
 348 <ul class="subNavList">
 349 <li>Summary:&nbsp;</li>
 350 <li>Nested&nbsp;|&nbsp;</li>
 351 <li>Field&nbsp;|&nbsp;</li>
 352 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 353 <li><a href="#method.summary">Method</a></li>
 354 </ul>
 355 <ul class="subNavList">
 356 <li>Detail:&nbsp;</li>
 357 <li>Field&nbsp;|&nbsp;</li>
 358 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 359 <li><a href="#method.detail">Method</a></li>
 360 </ul>
 361 </div>
 362 <a name="skip.navbar.bottom">
 363 <!--   -->
 364 </a></div>
 365 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 366 </body>
 367 </html>