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>
<li><ahref="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html"title="class in com.captainalm.lib.calmnet.packet.fragment"><spanclass="typeNameLink">Prev Class</span></a></li>
<li><ahref="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentRetrySendPacket.html"title="class in com.captainalm.lib.calmnet.packet.fragment"><spanclass="typeNameLink">Next Class</span></a></li>
<thclass="colOne"scope="col">Constructor and Description</th>
</tr>
<trclass="altColor">
<tdclass="colOne"><code><spanclass="memberNameLink"><ahref="../../../../../../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>(<ahref="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html"title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a> loader,
<ahref="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html"title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a> factory)</code>
<divclass="block">Constructs a new FragmentReceiver with the specified <ahref="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html"title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a> and <ahref="../../../../../../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 =========== -->
<ulclass="blockList">
<liclass="blockList"><aname="method.summary">
<!---->
</a>
<h3>Method Summary</h3>
<tableclass="memberSummary"border="0"cellpadding="3"cellspacing="0"summary="Method Summary table, listing methods, and an explanation">
<divclass="block">Gets the number of <ahref="../../../../../../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 <ahref="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSendCompletePacket.html"title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentSendCompletePacket</code></a> or <ahref="../../../../../../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>
<trid="i8"class="altColor">
<tdclass="colFirst"><code><ahref="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html"title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a></code></td>
<divclass="block">Gets the <ahref="../../../../../../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>
<trid="i9"class="rowColor">
<tdclass="colFirst"><code><ahref="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html"title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a></code></td>
<divclass="block">Gets the <ahref="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html"title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a> in use.</div>
<divclass="block">Polls the last finished packet ID.</div>
</td>
</tr>
<trid="i11"class="rowColor">
<tdclass="colFirst"><code><ahref="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html"title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></code></td>
<divclass="block">Receives a <ahref="../../../../../../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>
<trid="i12"class="altColor">
<tdclass="colFirst"><code>boolean</code></td>
<tdclass="colLast"><code><spanclass="memberNameLink"><ahref="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#receivePacket-com.captainalm.lib.calmnet.packet.IPacket-">receivePacket</a></span>(<ahref="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html"title="interface in com.captainalm.lib.calmnet.packet">IPacket</a> packetIn)</code>
<divclass="block">Receives a <ahref="../../../../../../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>
<trid="i13"class="rowColor">
<tdclass="colFirst"><code><ahref="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html"title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></code></td>
<divclass="block">Receives a <ahref="../../../../../../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>
<trid="i14"class="altColor">
<tdclass="colFirst"><code><ahref="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html"title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>[]</code></td>
<divclass="block">Sends the current <ahref="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html"title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>s from the FragmentReceiver.</div>
<divclass="block">Sets the number of <ahref="../../../../../../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 <ahref="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSendCompletePacket.html"title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentSendCompletePacket</code></a> or <ahref="../../../../../../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>
<trid="i16"class="altColor">
<tdclass="colFirst"><code>void</code></td>
<tdclass="colLast"><code><spanclass="memberNameLink"><ahref="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setPacketFactory-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-">setPacketFactory</a></span>(<ahref="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html"title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a> factory)</code>
<divclass="block">Sets the <ahref="../../../../../../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>
<trid="i17"class="rowColor">
<tdclass="colFirst"><code>void</code></td>
<tdclass="colLast"><code><spanclass="memberNameLink"><ahref="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setPacketLoader-com.captainalm.lib.calmnet.packet.PacketLoader-">setPacketLoader</a></span>(<ahref="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html"title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a> loader)</code>
<divclass="block">Sets the <ahref="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html"title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a> to use.</div>
<divclass="block">Stops data verification for all packets being received when <ahref="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#shouldSentDataBeAllVerified--"><code>shouldSentDataBeAllVerified()</code></a> is true.</div>
<divclass="block">Stops data verification for the specified Packet ID when <ahref="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#shouldSentDataBeAllVerified--"><code>shouldSentDataBeAllVerified()</code></a> is true.</div>
<pre>public FragmentReceiver(<ahref="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html"title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a> loader,
<ahref="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html"title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a> factory)</pre>
<divclass="block">Constructs a new FragmentReceiver with the specified <ahref="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html"title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a> and <ahref="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html"title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>.</div>
<dd><code>loader</code> - The packet loader to use.</dd>
<dd><code>factory</code> - The packet factory to use.</dd>
<dt><spanclass="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - loader or factory is null.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ulclass="blockList">
<liclass="blockList"><aname="method.detail">
<!---->
</a>
<h3>Method Detail</h3>
<aname="receivePacket--">
<!---->
</a>
<ulclass="blockList">
<liclass="blockList">
<h4>receivePacket</h4>
<pre>public <ahref="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html"title="interface in com.captainalm.lib.calmnet.packet">IPacket</a> receivePacket()
throws java.lang.InterruptedException</pre>
<divclass="block">Receives a <ahref="../../../../../../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><spanclass="returnLabel">Returns:</span></dt>
<dd>The received packet.</dd>
<dt><spanclass="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code> - The Thread was Interrupted.</dd>
</dl>
</li>
</ul>
<aname="receivePacketPolling--">
<!---->
</a>
<ulclass="blockList">
<liclass="blockList">
<h4>receivePacketPolling</h4>
<pre>public <ahref="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html"title="interface in com.captainalm.lib.calmnet.packet">IPacket</a> receivePacketPolling()</pre>
<divclass="block">Receives a <ahref="../../../../../../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><spanclass="returnLabel">Returns:</span></dt>
<dd>The received packet or null.</dd>
</dl>
</li>
</ul>
<aname="sendPacket--">
<!---->
</a>
<ulclass="blockList">
<liclass="blockList">
<h4>sendPacket</h4>
<pre>public <ahref="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html"title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>[] sendPacket()
throws <ahref="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html"title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
<divclass="block">Sends the current <ahref="../../../../../../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><spanclass="returnLabel">Returns:</span></dt>
<dd>The packets to send.</dd>
<dt><spanclass="throwsLabel">Throws:</span></dt>
<dd><code><ahref="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html"title="class in com.captainalm.lib.calmnet.packet">PacketException</a></code> - A Packet Exception has occurred.</dd>
<pre>public boolean receivePacket(<ahref="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html"title="interface in com.captainalm.lib.calmnet.packet">IPacket</a> packetIn)
throws <ahref="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html"title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
<divclass="block">Receives a <ahref="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html"title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> into the FragmentReceiver.</div>
<dd><code>packetIn</code> - The packet to receive.</dd>
<dt><spanclass="returnLabel">Returns:</span></dt>
<dd>If the received packet was a fragment packet.</dd>
<dt><spanclass="throwsLabel">Throws:</span></dt>
<dd><code><ahref="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html"title="class in com.captainalm.lib.calmnet.packet">PacketException</a></code> - A Packet Exception has occurred.</dd>
<divclass="block">Clears all the last finished packet IDs.</div>
</li>
</ul>
<aname="getPacketFactory--">
<!---->
</a>
<ulclass="blockList">
<liclass="blockList">
<h4>getPacketFactory</h4>
<pre>public <ahref="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html"title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a> getPacketFactory()</pre>
<divclass="block">Gets the <ahref="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html"title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a> in use.</div>
<pre>public void setPacketFactory(<ahref="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html"title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a> factory)</pre>
<divclass="block">Sets the <ahref="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html"title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a> to use.</div>
<dd><code>factory</code> - The packet factory to use.</dd>
<dt><spanclass="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - factory is null.</dd>
</dl>
</li>
</ul>
<aname="getPacketLoader--">
<!---->
</a>
<ulclass="blockList">
<liclass="blockList">
<h4>getPacketLoader</h4>
<pre>public <ahref="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html"title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a> getPacketLoader()</pre>
<divclass="block">Gets the <ahref="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html"title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a> in use.</div>
<pre>public void setPacketLoader(<ahref="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html"title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a> loader)</pre>
<divclass="block">Sets the <ahref="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html"title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a> to use.</div>
If set to false, <ahref="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setSentDataWillBeAllVerified-boolean-"><code>setSentDataWillBeAllVerified(boolean)</code></a> will be set to false too.</div>
Requires <ahref="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setResponseVerification-boolean-"><code>setResponseVerification(boolean)</code></a> set to true.</div>
<divclass="block">Gets the number of <ahref="../../../../../../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 <ahref="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSendCompletePacket.html"title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentSendCompletePacket</code></a> or <ahref="../../../../../../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 <ahref="../../../../../../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
<ahref="../../../../../../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 <ahref="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#shouldSentDataBeAllVerified--"><code>shouldSentDataBeAllVerified()</code></a>.</div>
<dl>
<dt><spanclass="returnLabel">Returns:</span></dt>
<dd>The number of send packet calls before a completion or restart is forced.</dd>
<divclass="block">Sets the number of <ahref="../../../../../../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 <ahref="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSendCompletePacket.html"title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentSendCompletePacket</code></a> or <ahref="../../../../../../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 <ahref="../../../../../../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
<ahref="../../../../../../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 <ahref="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#shouldSentDataBeAllVerified--"><code>shouldSentDataBeAllVerified()</code></a>.</div>
<divclass="block">Stops data verification for the specified Packet ID when <ahref="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#shouldSentDataBeAllVerified--"><code>shouldSentDataBeAllVerified()</code></a> is true.</div>
<divclass="block">Stops data verification for all packets being received when <ahref="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#shouldSentDataBeAllVerified--"><code>shouldSentDataBeAllVerified()</code></a> is true.</div>
<li><ahref="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html"title="class in com.captainalm.lib.calmnet.packet.fragment"><spanclass="typeNameLink">Prev Class</span></a></li>
<li><ahref="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentRetrySendPacket.html"title="class in com.captainalm.lib.calmnet.packet.fragment"><spanclass="typeNameLink">Next Class</span></a></li>