alfred/calmnetlib
1
0
Fork 0
Code Issues Pull Requests Projects Releases 2 Wiki Activity
master
calmnetlib/JavaDoc/com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html

773 lines
42 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_262) on Sun Jun 11 02:31:49 BST 2023 -->
<title>FragmentReceiver</title>
<meta name="date" content="2023-06-11">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="FragmentReceiver";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentRetrySendPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" target="_top">Frames</a></li>
<li><a href="FragmentReceiver.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.captainalm.lib.calmnet.packet.fragment</div>
<h2 title="Class FragmentReceiver" class="title">Class FragmentReceiver</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.packet.fragment.FragmentReceiver</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">FragmentReceiver</span>
extends java.lang.Object</pre>
<div class="block">This class provides the ability to re-construct packets from <code>com.captainalm.lib.calmnet.packet.fragment</code>.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Captain ALM</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#FragmentReceiver-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-">FragmentReceiver</a></span>(<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a>&nbsp;loader,
<a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory)</code>
<div class="block">Constructs a new FragmentReceiver with the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a> and <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#areFinishedIDsWaiting--">areFinishedIDsWaiting</a></span>()</code>
<div class="block">Gets whether finished IDs are waiting for obtaining.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#arePacketsWaiting--">arePacketsWaiting</a></span>()</code>
<div class="block">Gets whether packets are waiting to be received.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#clearLastIDFinished--">clearLastIDFinished</a></span>()</code>
<div class="block">Clears all the last finished packet IDs.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#clearRegistry--">clearRegistry</a></span>()</code>
<div class="block">Clears the registry (And requests the sender to stop sending).</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#clearWaitingPackets--">clearWaitingPackets</a></span>()</code>
<div class="block">Clears the currently waiting packets.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#deletePacketFromRegistry-int-">deletePacketFromRegistry</a></span>(int&nbsp;id)</code>
<div class="block">Deletes a packet from the registry and requests the sender to stop sending.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#getLastIDFinished--">getLastIDFinished</a></span>()</code>
<div class="block">Gets the last finished packet ID.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#getNumberOfEmptySendsTillForcedCompleteOrResend--">getNumberOfEmptySendsTillForcedCompleteOrResend</a></span>()</code>
<div class="block">Gets the number of <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#sendPacket--"><code>sendPacket()</code></a> calls, that return null, to a registry entry are made before
the <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSendCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentSendCompletePacket</code></a> or <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentRetrySendPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentRetrySendPacket</code></a> packets are sent.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#getPacketFactory--">getPacketFactory</a></span>()</code>
<div class="block">Gets the <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a> in use.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#getPacketLoader--">getPacketLoader</a></span>()</code>
<div class="block">Gets the <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a> in use.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.Integer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#pollLastIDFinished--">pollLastIDFinished</a></span>()</code>
<div class="block">Polls the last finished packet ID.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#receivePacket--">receivePacket</a></span>()</code>
<div class="block">Receives a <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> from the FragmentReceiver.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#receivePacket-com.captainalm.lib.calmnet.packet.IPacket-">receivePacket</a></span>(<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packetIn)</code>
<div class="block">Receives a <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> into the FragmentReceiver.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#receivePacketPolling--">receivePacketPolling</a></span>()</code>
<div class="block">Receives a <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> from the FragmentReceiver.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#sendPacket--">sendPacket</a></span>()</code>
<div class="block">Sends the current <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>s from the FragmentReceiver.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setNumberOfEmptySendsTillForcedCompleteOrResend-int-">setNumberOfEmptySendsTillForcedCompleteOrResend</a></span>(int&nbsp;numberOfEmptySends)</code>
<div class="block">Sets the number of <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#sendPacket--"><code>sendPacket()</code></a> calls, that return null, to a registry entry are made before
the <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSendCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentSendCompletePacket</code></a> or <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentRetrySendPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentRetrySendPacket</code></a> packets are sent.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setPacketFactory-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-">setPacketFactory</a></span>(<a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory)</code>
<div class="block">Sets the <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a> to use.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setPacketLoader-com.captainalm.lib.calmnet.packet.PacketLoader-">setPacketLoader</a></span>(<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a>&nbsp;loader)</code>
<div class="block">Sets the <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a> to use.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setResponseVerification-boolean-">setResponseVerification</a></span>(boolean&nbsp;state)</code>
<div class="block">Sets whether responses should be verified by sending back the payload to be verified.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setSentDataWillBeAllVerified-boolean-">setSentDataWillBeAllVerified</a></span>(boolean&nbsp;state)</code>
<div class="block">Gets whether all sent fragments are expected to be verified.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#shouldSentDataBeAllVerified--">shouldSentDataBeAllVerified</a></span>()</code>
<div class="block">Gets whether all sent fragments are expected to be verified.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#shouldVerifyResponses--">shouldVerifyResponses</a></span>()</code>
<div class="block">Gets whether responses should be verified by sending back the payload to be verified.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#stopAllDataVerificationAndCompleteReceive--">stopAllDataVerificationAndCompleteReceive</a></span>()</code>
<div class="block">Stops data verification for all packets being received when <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#shouldSentDataBeAllVerified--"><code>shouldSentDataBeAllVerified()</code></a> is true.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#stopDataVerificationAndCompleteReceive-int-">stopDataVerificationAndCompleteReceive</a></span>(int&nbsp;id)</code>
<div class="block">Stops data verification for the specified Packet ID when <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#shouldSentDataBeAllVerified--"><code>shouldSentDataBeAllVerified()</code></a> is true.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="FragmentReceiver-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FragmentReceiver</h4>
<pre>public&nbsp;FragmentReceiver(<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a>&nbsp;loader,
<a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory)</pre>
<div class="block">Constructs a new FragmentReceiver with the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a> and <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>loader</code> - The packet loader to use.</dd>
<dd><code>factory</code> - The packet factory to use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - loader or factory is null.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="receivePacket--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>receivePacket</h4>
<pre>public&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;receivePacket()
throws java.lang.InterruptedException</pre>
<div class="block">Receives a <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> from the FragmentReceiver.
This method blocks until a packet can be received.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The received packet.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code> - The Thread was Interrupted.</dd>
</dl>
</li>
</ul>
<a name="receivePacketPolling--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>receivePacketPolling</h4>
<pre>public&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;receivePacketPolling()</pre>
<div class="block">Receives a <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> from the FragmentReceiver.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The received packet or null.</dd>
</dl>
</li>
</ul>
<a name="sendPacket--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendPacket</h4>
<pre>public&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>[]&nbsp;sendPacket()
throws <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
<div class="block">Sends the current <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>s from the FragmentReceiver.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The packets to send.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></code> - A Packet Exception has occurred.</dd>
</dl>
</li>
</ul>
<a name="receivePacket-com.captainalm.lib.calmnet.packet.IPacket-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>receivePacket</h4>
<pre>public&nbsp;boolean&nbsp;receivePacket(<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packetIn)
throws <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
<div class="block">Receives a <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> into the FragmentReceiver.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>packetIn</code> - The packet to receive.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If the received packet was a fragment packet.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></code> - A Packet Exception has occurred.</dd>
</dl>
</li>
</ul>
<a name="arePacketsWaiting--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>arePacketsWaiting</h4>
<pre>public&nbsp;boolean&nbsp;arePacketsWaiting()</pre>
<div class="block">Gets whether packets are waiting to be received.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If packets are waiting to be received.</dd>
</dl>
</li>
</ul>
<a name="clearWaitingPackets--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearWaitingPackets</h4>
<pre>public&nbsp;void&nbsp;clearWaitingPackets()</pre>
<div class="block">Clears the currently waiting packets.</div>
</li>
</ul>
<a name="deletePacketFromRegistry-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deletePacketFromRegistry</h4>
<pre>public&nbsp;void&nbsp;deletePacketFromRegistry(int&nbsp;id)</pre>
<div class="block">Deletes a packet from the registry and requests the sender to stop sending.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - The ID of the packet to remove.</dd>
</dl>
</li>
</ul>
<a name="clearRegistry--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearRegistry</h4>
<pre>public&nbsp;void&nbsp;clearRegistry()</pre>
<div class="block">Clears the registry (And requests the sender to stop sending).
NOTE: Do NOT do this unless you are finished with the FragmentReceiver.</div>
</li>
</ul>
<a name="areFinishedIDsWaiting--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>areFinishedIDsWaiting</h4>
<pre>public&nbsp;boolean&nbsp;areFinishedIDsWaiting()</pre>
<div class="block">Gets whether finished IDs are waiting for obtaining.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If finished IDs are waiting for obtaining.</dd>
</dl>
</li>
</ul>
<a name="getLastIDFinished--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLastIDFinished</h4>
<pre>public&nbsp;int&nbsp;getLastIDFinished()
throws java.lang.InterruptedException</pre>
<div class="block">Gets the last finished packet ID.
This method blocks until a packet finishes processing.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The last finished packet ID.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code> - The Thread was Interrupted.</dd>
</dl>
</li>
</ul>
<a name="pollLastIDFinished--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pollLastIDFinished</h4>
<pre>public&nbsp;java.lang.Integer&nbsp;pollLastIDFinished()</pre>
<div class="block">Polls the last finished packet ID.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The last finished packet ID.</dd>
</dl>
</li>
</ul>
<a name="clearLastIDFinished--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearLastIDFinished</h4>
<pre>public&nbsp;void&nbsp;clearLastIDFinished()</pre>
<div class="block">Clears all the last finished packet IDs.</div>
</li>
</ul>
<a name="getPacketFactory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPacketFactory</h4>
<pre>public&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;getPacketFactory()</pre>
<div class="block">Gets the <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a> in use.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The PacketFactory in use.</dd>
</dl>
</li>
</ul>
<a name="setPacketFactory-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPacketFactory</h4>
<pre>public&nbsp;void&nbsp;setPacketFactory(<a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory)</pre>
<div class="block">Sets the <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a> to use.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - The packet factory to use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - factory is null.</dd>
</dl>
</li>
</ul>
<a name="getPacketLoader--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPacketLoader</h4>
<pre>public&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a>&nbsp;getPacketLoader()</pre>
<div class="block">Gets the <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a> in use.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The PacketLoader in use.</dd>
</dl>
</li>
</ul>
<a name="setPacketLoader-com.captainalm.lib.calmnet.packet.PacketLoader-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPacketLoader</h4>
<pre>public&nbsp;void&nbsp;setPacketLoader(<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a>&nbsp;loader)</pre>
<div class="block">Sets the <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a> to use.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>loader</code> - The packet loader to use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - loader is null.</dd>
</dl>
</li>
</ul>
<a name="shouldVerifyResponses--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldVerifyResponses</h4>
<pre>public&nbsp;boolean&nbsp;shouldVerifyResponses()</pre>
<div class="block">Gets whether responses should be verified by sending back the payload to be verified.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Should responses be verified by sending back the payload.</dd>
</dl>
</li>
</ul>
<a name="setResponseVerification-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setResponseVerification</h4>
<pre>public&nbsp;void&nbsp;setResponseVerification(boolean&nbsp;state)</pre>
<div class="block">Sets whether responses should be verified by sending back the payload to be verified.
If set to false, <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setSentDataWillBeAllVerified-boolean-"><code>setSentDataWillBeAllVerified(boolean)</code></a> will be set to false too.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>state</code> - If responses should be verified by sending back the payload.</dd>
</dl>
</li>
</ul>
<a name="shouldSentDataBeAllVerified--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldSentDataBeAllVerified</h4>
<pre>public&nbsp;boolean&nbsp;shouldSentDataBeAllVerified()</pre>
<div class="block">Gets whether all sent fragments are expected to be verified.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If all sent fragments are expected to be verified.</dd>
</dl>
</li>
</ul>
<a name="setSentDataWillBeAllVerified-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSentDataWillBeAllVerified</h4>
<pre>public&nbsp;void&nbsp;setSentDataWillBeAllVerified(boolean&nbsp;state)</pre>
<div class="block">Gets whether all sent fragments are expected to be verified.
Requires <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setResponseVerification-boolean-"><code>setResponseVerification(boolean)</code></a> set to true.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>state</code> - If all sent fragments are expected to be verified.</dd>
</dl>
</li>
</ul>
<a name="getNumberOfEmptySendsTillForcedCompleteOrResend--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumberOfEmptySendsTillForcedCompleteOrResend</h4>
<pre>public&nbsp;int&nbsp;getNumberOfEmptySendsTillForcedCompleteOrResend()</pre>
<div class="block">Gets the number of <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#sendPacket--"><code>sendPacket()</code></a> calls, that return null, to a registry entry are made before
the <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSendCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentSendCompletePacket</code></a> or <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentRetrySendPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentRetrySendPacket</code></a> packets are sent.
A <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSendCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentSendCompletePacket</code></a> is sent if completely received and a
<a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentRetrySendPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentRetrySendPacket</code></a> is sent if not completely received.
This excludes empty packets due to <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#shouldSentDataBeAllVerified--"><code>shouldSentDataBeAllVerified()</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of send packet calls before a completion or restart is forced.</dd>
</dl>
</li>
</ul>
<a name="setNumberOfEmptySendsTillForcedCompleteOrResend-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNumberOfEmptySendsTillForcedCompleteOrResend</h4>
<pre>public&nbsp;void&nbsp;setNumberOfEmptySendsTillForcedCompleteOrResend(int&nbsp;numberOfEmptySends)</pre>
<div class="block">Sets the number of <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#sendPacket--"><code>sendPacket()</code></a> calls, that return null, to a registry entry are made before
the <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSendCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentSendCompletePacket</code></a> or <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentRetrySendPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentRetrySendPacket</code></a> packets are sent.
A <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSendCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentSendCompletePacket</code></a> is sent if completely received and a
<a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentRetrySendPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentRetrySendPacket</code></a> is sent if not completely received.
This excludes empty packets due to <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#shouldSentDataBeAllVerified--"><code>shouldSentDataBeAllVerified()</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>numberOfEmptySends</code> - The number of empty sends to allow.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - numberOfEmptySends is less than 1.</dd>
</dl>
</li>
</ul>
<a name="stopDataVerificationAndCompleteReceive-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopDataVerificationAndCompleteReceive</h4>
<pre>public&nbsp;void&nbsp;stopDataVerificationAndCompleteReceive(int&nbsp;id)</pre>
<div class="block">Stops data verification for the specified Packet ID when <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#shouldSentDataBeAllVerified--"><code>shouldSentDataBeAllVerified()</code></a> is true.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - The PacketID to act on.</dd>
</dl>
</li>
</ul>
<a name="stopAllDataVerificationAndCompleteReceive--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>stopAllDataVerificationAndCompleteReceive</h4>
<pre>public&nbsp;void&nbsp;stopAllDataVerificationAndCompleteReceive()</pre>
<div class="block">Stops data verification for all packets being received when <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#shouldSentDataBeAllVerified--"><code>shouldSentDataBeAllVerified()</code></a> is true.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentRetrySendPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" target="_top">Frames</a></li>
<li><a href="FragmentReceiver.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink