<!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:21 BST 2023 --> <title>IStreamedPacket</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="IStreamedPacket"; } } catch(err) { } //--> var methods = {"i0":6,"i1":6,"i2":6}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?com/captainalm/lib/calmnet/packet/IStreamedPacket.html" target="_top">Frames</a></li> <li><a href="IStreamedPacket.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>Constr | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </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</div> <h2 title="Interface IStreamedPacket" class="title">Interface IStreamedPacket</h2> </div> <div class="contentContainer"> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Superinterfaces:</dt> <dd><a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></dd> </dl> <dl> <dt>All Known Implementing Classes:</dt> <dd><a href="../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core">Base64Packet</a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionCipherPacket</a></dd> </dl> <hr> <br> <pre>public interface <span class="typeNameLabel">IStreamedPacket</span> extends <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></pre> <div class="block">This interface provides the streaming packet methods.</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"> <!-- ========== 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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html#getSize--">getSize</a></span>()</code> <div class="block">Gets the size of the output data.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html#readData-java.io.OutputStream-">readData</a></span>(java.io.OutputStream outputStream)</code> <div class="block">Reads payload data to an <code>OutputStream</code>.</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/IStreamedPacket.html#writeData-java.io.InputStream-int-">writeData</a></span>(java.io.InputStream inputStream, int size)</code> <div class="block">Writes payload data from an <code>InputStream</code>.</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.com.captainalm.lib.calmnet.packet.IPacket"> <!-- --> </a> <h3>Methods inherited from interface com.captainalm.lib.calmnet.packet.<a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></h3> <code><a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#getProtocol--">getProtocol</a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#isValid--">isValid</a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#loadPayload-byte:A-">loadPayload</a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#savePayload--">savePayload</a></code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="readData-java.io.OutputStream-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>readData</h4> <pre>void readData(java.io.OutputStream outputStream) throws java.io.IOException, <a href="../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre> <div class="block">Reads payload data to an <code>OutputStream</code>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>outputStream</code> - The output stream to read data to.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.lang.NullPointerException</code> - outputStream is null.</dd> <dd><code>java.io.IOException</code> - An IO Exception has occurred.</dd> <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> <a name="writeData-java.io.InputStream-int-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeData</h4> <pre>void writeData(java.io.InputStream inputStream, int size) throws java.io.IOException, <a href="../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre> <div class="block">Writes payload data from an <code>InputStream</code>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>inputStream</code> - The input stream to write data from.</dd> <dd><code>size</code> - The size of the input payload in bytes.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.lang.NullPointerException</code> - inputStream is null.</dd> <dd><code>java.lang.IllegalArgumentException</code> - size is less than 0.</dd> <dd><code>java.io.IOException</code> - An IO Exception has occurred.</dd> <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> <a name="getSize--"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getSize</h4> <pre>int getSize() throws <a href="../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre> <div class="block">Gets the size of the output data.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>The size of the output data in bytes.</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/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?com/captainalm/lib/calmnet/packet/IStreamedPacket.html" target="_top">Frames</a></li> <li><a href="IStreamedPacket.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>Constr | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> </body> </html>