<!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 Tue May 23 15:22:20 BST 2023 --> <title>FragmentMessagePacket</title> <meta name="date" content="2023-05-23"> <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="FragmentMessagePacket"; } } catch(err) { } //--> var methods = {"i0":10,"i1":9,"i2":10,"i3":10}; var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/FragmentAllocationPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentMessageResponsePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html" target="_top">Frames</a></li> <li><a href="FragmentMessagePacket.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor.detail">Constr</a> | </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 FragmentMessagePacket" class="title">Class FragmentMessagePacket</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">com.captainalm.lib.calmnet.packet.fragment.FragmentPIDPacket</a></li> <li> <ul class="inheritance"> <li><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">com.captainalm.lib.calmnet.packet.fragment.FragmentPIDMSGPacket</a></li> <li> <ul class="inheritance"> <li>com.captainalm.lib.calmnet.packet.fragment.FragmentMessagePacket</li> </ul> </li> </ul> </li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></dd> </dl> <hr> <br> <pre>public class <span class="typeNameLabel">FragmentMessagePacket</span> extends <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDMSGPacket</a></pre> <div class="block">This class provides a packet for sending a payload with a packetID and fragmentID. The response packet is: <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentMessageResponsePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentMessageResponsePacket</code></a>. <p> Major ID: 254 Minor ID: 3 </p></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"> </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/FragmentMessagePacket.html#FragmentMessagePacket-java.lang.Integer-java.lang.Integer-byte:A-">FragmentMessagePacket</a></span>(java.lang.Integer packetID, java.lang.Integer fragmentID, byte[] payload)</code> <div class="block">Constructs a new FragmentMessagePacket given the packet ID, fragment ID and payload.</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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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> <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><a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html#getProtocol--">getProtocol</a></span>()</code> <div class="block">Gets the protocol information.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html#getTheProtocol--">getTheProtocol</a></span>()</code> <div class="block">Gets the protocol information statically.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html#isValid--">isValid</a></span>()</code> <div class="block">Gets if the packet is valid.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>byte[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html#savePayload--">savePayload</a></span>()</code> <div class="block">Saves the packet payload to a byte array.</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.com.captainalm.lib.calmnet.packet.fragment.FragmentPIDMSGPacket"> <!-- --> </a> <h3>Methods inherited from class com.captainalm.lib.calmnet.packet.fragment.<a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDMSGPacket</a></h3> <code><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html#getFragmentID--">getFragmentID</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html#getFragmentMessage--">getFragmentMessage</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html#loadPayload-byte:A-">loadPayload</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.com.captainalm.lib.calmnet.packet.fragment.FragmentPIDPacket"> <!-- --> </a> <h3>Methods inherited from class com.captainalm.lib.calmnet.packet.fragment.<a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDPacket</a></h3> <code><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html#getPacketID--">getPacketID</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class 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="FragmentMessagePacket-java.lang.Integer-java.lang.Integer-byte:A-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>FragmentMessagePacket</h4> <pre>public FragmentMessagePacket(java.lang.Integer packetID, java.lang.Integer fragmentID, byte[] payload)</pre> <div class="block">Constructs a new FragmentMessagePacket given the packet ID, fragment ID and payload.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>packetID</code> - The packet ID.</dd> <dd><code>fragmentID</code> - The fragment ID.</dd> <dd><code>payload</code> - The payload to store.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.lang.IllegalArgumentException</code> - packetID or fragmentID is less than 0.</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="isValid--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isValid</h4> <pre>public boolean isValid()</pre> <div class="block">Gets if the packet is valid.</div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#isValid--">isValid</a></code> in interface <code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></code></dd> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html#isValid--">isValid</a></code> in class <code><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDMSGPacket</a></code></dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>Is the packet valid?</dd> </dl> </li> </ul> <a name="getProtocol--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getProtocol</h4> <pre>public <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a> getProtocol()</pre> <div class="block">Gets the protocol information.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>The protocol information.</dd> </dl> </li> </ul> <a name="getTheProtocol--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getTheProtocol</h4> <pre>public static <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a> getTheProtocol()</pre> <div class="block">Gets the protocol information statically.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>The protocol information.</dd> </dl> </li> </ul> <a name="savePayload--"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>savePayload</h4> <pre>public byte[] savePayload() throws <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre> <div class="block">Saves the packet payload to a byte array.</div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#savePayload--">savePayload</a></code> in interface <code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></code></dd> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html#savePayload--">savePayload</a></code> in class <code><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDMSGPacket</a></code></dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>The packet payload data.</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> - An Exception has occurred.</dd> </dl> </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/FragmentAllocationPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentMessageResponsePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html" target="_top">Frames</a></li> <li><a href="FragmentMessagePacket.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> </body> </html>