calmnetlib/JavaDoc/com/captainalm/lib/calmnet/packet/fragment/package-summary.html

236 lines
12 KiB
HTML

<!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:50 BST 2023 -->
<title>com.captainalm.lib.calmnet.packet.fragment</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="com.captainalm.lib.calmnet.packet.fragment";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>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/factory/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/ssl/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/fragment/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;com.captainalm.lib.calmnet.packet.fragment</h1>
<div class="docSummary">
<div class="block">This package contains the fragment network packets and
the <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentReceiver</code></a> and <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentSender</code></a> objects.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentAllocatePacket</a></td>
<td class="colLast">
<div class="block">This class provides a packet for fragment allocation requesting.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentAllocationPacket</a></td>
<td class="colLast">
<div class="block">This class provides a packet for giving the allocated packetID
as a response for <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentAllocatePacket</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentMessagePacket</a></td>
<td class="colLast">
<div class="block">This class provides a packet for sending a payload with a packetID and fragmentID.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentMessageResponsePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentMessageResponsePacket</a></td>
<td class="colLast">
<div class="block">This class provides a packet for sending an optional payload with a packetID and fragmentID
as a response for <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentMessagePacket</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDAKNPacket</a></td>
<td class="colLast">
<div class="block">This abstract base class provides the ability for packets to contain an ID and if it is an Acknowledgement.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDMSGPacket</a></td>
<td class="colLast">
<div class="block">This abstract base class provides the ability for packets to contain an ID, a Fragment ID and a payload.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDPacket</a></td>
<td class="colLast">
<div class="block">This abstract base class provides the ability for packets to return an ID.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></td>
<td class="colLast">
<div class="block">This class provides the ability to re-construct packets from <code>com.captainalm.lib.calmnet.packet.fragment</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentRetrySendPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentRetrySendPacket</a></td>
<td class="colLast">
<div class="block">This class provides a packet for signalling that the sending end
should start re-sending un acknowledged fragment packets.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSendCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendCompletePacket</a></td>
<td class="colLast">
<div class="block">This class provides a packet for signalling that all fragments for a packet have been sent or that sending has been successfully cancelled.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a></td>
<td class="colLast">
<div class="block">This class provides the ability to create packets for <code>com.captainalm.lib.calmnet.packet.fragment</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSendStopPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendStopPacket</a></td>
<td class="colLast">
<div class="block">This class provides a packet for stopping the remote <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentSender</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSendVerifyCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendVerifyCompletePacket</a></td>
<td class="colLast">
<div class="block">This class provides a packet for stating that all packets have been successfully sent and verified.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package com.captainalm.lib.calmnet.packet.fragment Description">Package com.captainalm.lib.calmnet.packet.fragment Description</h2>
<div class="block">This package contains the fragment network packets and
the <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentReceiver</code></a> and <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentSender</code></a> objects.
<p>
Major ID: 254
</p></div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Captain ALM</dd>
</dl>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>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/factory/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/ssl/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/fragment/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>