Add build artifact and JavaDoc.

This commit is contained in:
Captain ALM 2023-05-23 15:24:10 +01:00
parent b8179ca1c0
commit 590b7c5d5d
Signed by: alfred
GPG Key ID: 4E4ADD02609997B1
95 changed files with 28175 additions and 0 deletions

View File

@ -0,0 +1,8 @@
<component name="ArtifactManager">
<artifact type="jar" build-on-make="true" name="calmnetlib">
<output-path>$PROJECT_DIR$/out/artifacts/calmnetlib</output-path>
<root id="archive" name="calmnetlib.jar">
<element id="module-output" name="calmnetlib" />
</root>
</artifact>
</component>

View File

@ -1,5 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="JavadocGenerationManager">
<option name="OUTPUT_DIRECTORY" value="$PROJECT_DIR$/JavaDoc" />
<option name="OPTION_SCOPE" value="public" />
<option name="OPTION_DOCUMENT_TAG_AUTHOR" value="true" />
</component>
<component name="ProjectRootManager" version="2" languageLevel="JDK_1_8" project-jdk-name="1.8" project-jdk-type="JavaSDK">
<output url="file://$PROJECT_DIR$/out" />
</component>

View File

@ -0,0 +1,58 @@
<!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:22 BST 2023 -->
<title>All Classes</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>
<h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core" target="classFrame">Base64Packet</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html" title="class in com.captainalm.lib.calmnet.packet.factory" target="classFrame">CALMNETPacketFactory</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactoryWithPacket.html" title="class in com.captainalm.lib.calmnet.packet.factory" target="classFrame">CALMNETPacketFactoryWithPacket</a></li>
<li><a href="com/captainalm/lib/calmnet/marshal/CandidateClient.html" title="class in com.captainalm.lib.calmnet.marshal" target="classFrame">CandidateClient</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core" target="classFrame">EncryptedPacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentAllocatePacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentAllocationPacket</a></li>
<li><a href="com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal" target="classFrame">FragmentationOptions</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentMessagePacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentMessageResponsePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentMessageResponsePacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentPIDAKNPacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentPIDMSGPacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentPIDPacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentReceiver</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentRetrySendPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentRetrySendPacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentSendCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentSendCompletePacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentSender</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentSendStopPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentSendStopPacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentSendVerifyCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentSendVerifyCompletePacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet" target="classFrame"><span class="interfaceName">IAcknowledgement</span></a></li>
<li><a href="com/captainalm/lib/calmnet/packet/IInternalCache.html" title="interface in com.captainalm.lib.calmnet.packet" target="classFrame"><span class="interfaceName">IInternalCache</span></a></li>
<li><a href="com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet" target="classFrame"><span class="interfaceName">IPacket</span></a></li>
<li><a href="com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory" target="classFrame"><span class="interfaceName">IPacketFactory</span></a></li>
<li><a href="com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet" target="classFrame"><span class="interfaceName">IStreamedPacket</span></a></li>
<li><a href="com/captainalm/lib/calmnet/stream/LengthClampedInputStream.html" title="class in com.captainalm.lib.calmnet.stream" target="classFrame">LengthClampedInputStream</a></li>
<li><a href="com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal" target="classFrame">NetMarshalClient</a></li>
<li><a href="com/captainalm/lib/calmnet/marshal/NetMarshalClientWrapped.html" title="class in com.captainalm.lib.calmnet.marshal" target="classFrame">NetMarshalClientWrapped</a></li>
<li><a href="com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal" target="classFrame">NetMarshalServer</a></li>
<li><a href="com/captainalm/lib/calmnet/marshal/NetMarshalServerWrapped.html" title="class in com.captainalm.lib.calmnet.marshal" target="classFrame">NetMarshalServerWrapped</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core" target="classFrame">NetworkEncryptionCipherPacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core" target="classFrame">NetworkEncryptionUpgradePacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html" title="class in com.captainalm.lib.calmnet.packet.core" target="classFrame">NetworkIdentifierPacket</a></li>
<li><a href="com/captainalm/lib/calmnet/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream" target="classFrame">NetworkInputStream</a></li>
<li><a href="com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream" target="classFrame">NetworkOutputStream</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core" target="classFrame">NetworkSSLUpgradePacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet" target="classFrame">PacketException</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet" target="classFrame">PacketLoader</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet" target="classFrame">PacketProtocolInformation</a></li>
<li><a href="com/captainalm/lib/calmnet/ssl/SSLUtilities.html" title="class in com.captainalm.lib.calmnet.ssl" target="classFrame">SSLUtilities</a></li>
<li><a href="com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl" target="classFrame">SSLUtilityException</a></li>
</ul>
</div>
</body>
</html>

View File

@ -0,0 +1,58 @@
<!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:22 BST 2023 -->
<title>All Classes</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>
<h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core">Base64Packet</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactory</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactoryWithPacket.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactoryWithPacket</a></li>
<li><a href="com/captainalm/lib/calmnet/marshal/CandidateClient.html" title="class in com.captainalm.lib.calmnet.marshal">CandidateClient</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentAllocatePacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentAllocationPacket</a></li>
<li><a href="com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentMessagePacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentMessageResponsePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentMessageResponsePacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDAKNPacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDMSGPacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDPacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentRetrySendPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentRetrySendPacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentSendCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendCompletePacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentSendStopPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendStopPacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/FragmentSendVerifyCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendVerifyCompletePacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="interfaceName">IAcknowledgement</span></a></li>
<li><a href="com/captainalm/lib/calmnet/packet/IInternalCache.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="interfaceName">IInternalCache</span></a></li>
<li><a href="com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="interfaceName">IPacket</span></a></li>
<li><a href="com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><span class="interfaceName">IPacketFactory</span></a></li>
<li><a href="com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="interfaceName">IStreamedPacket</span></a></li>
<li><a href="com/captainalm/lib/calmnet/stream/LengthClampedInputStream.html" title="class in com.captainalm.lib.calmnet.stream">LengthClampedInputStream</a></li>
<li><a href="com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></li>
<li><a href="com/captainalm/lib/calmnet/marshal/NetMarshalClientWrapped.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClientWrapped</a></li>
<li><a href="com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></li>
<li><a href="com/captainalm/lib/calmnet/marshal/NetMarshalServerWrapped.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServerWrapped</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionCipherPacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionUpgradePacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkIdentifierPacket</a></li>
<li><a href="com/captainalm/lib/calmnet/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkInputStream</a></li>
<li><a href="com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkOutputStream</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkSSLUpgradePacket</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a></li>
<li><a href="com/captainalm/lib/calmnet/ssl/SSLUtilities.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilities</a></li>
<li><a href="com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></li>
</ul>
</div>
</body>
</html>

View File

@ -0,0 +1,400 @@
<!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>CandidateClient</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="CandidateClient";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":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>Prev&nbsp;Class</li>
<li><a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/marshal/CandidateClient.html" target="_top">Frames</a></li>
<li><a href="CandidateClient.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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.marshal</div>
<h2 title="Class CandidateClient" class="title">Class CandidateClient</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.marshal.CandidateClient</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">CandidateClient</span>
extends java.lang.Object</pre>
<div class="block">This class provides a candidate client for <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal"><code>NetMarshalServer</code></a>s.</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">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/CandidateClient.html#accept">accept</a></span></code>
<div class="block">Whether the candidate should be accepted.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.net.InetAddress</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/CandidateClient.html#address">address</a></span></code>
<div class="block">The remote address of the candidate.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/CandidateClient.html#port">port</a></span></code>
<div class="block">The remote port of the candidate.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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/marshal/CandidateClient.html#CandidateClient-java.net.InetAddress-int-">CandidateClient</a></span>(java.net.InetAddress&nbsp;address,
int&nbsp;port)</code>
<div class="block">Constructs a new instance of CandidateClient with an address and port.</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/marshal/CandidateClient.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;o)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/CandidateClient.html#hashCode--">hashCode</a></span>()</code>&nbsp;</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/marshal/CandidateClient.html#matchesNetMarshalClient-com.captainalm.lib.calmnet.marshal.NetMarshalClient-">matchesNetMarshalClient</a></span>(<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>&nbsp;toCheck)</code>
<div class="block">Checks if this candidate matches an existing <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal"><code>NetMarshalClient</code></a>.</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>getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="address">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>address</h4>
<pre>public final&nbsp;java.net.InetAddress address</pre>
<div class="block">The remote address of the candidate.</div>
</li>
</ul>
<a name="port">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>port</h4>
<pre>public final&nbsp;int port</pre>
<div class="block">The remote port of the candidate.</div>
</li>
</ul>
<a name="accept">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>accept</h4>
<pre>public&nbsp;boolean accept</pre>
<div class="block">Whether the candidate should be accepted.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CandidateClient-java.net.InetAddress-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CandidateClient</h4>
<pre>public&nbsp;CandidateClient(java.net.InetAddress&nbsp;address,
int&nbsp;port)</pre>
<div class="block">Constructs a new instance of CandidateClient with an address and port.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>address</code> - The remote address of the candidate.</dd>
<dd><code>port</code> - The remote port of the candidate.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - address 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="matchesNetMarshalClient-com.captainalm.lib.calmnet.marshal.NetMarshalClient-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>matchesNetMarshalClient</h4>
<pre>public&nbsp;boolean&nbsp;matchesNetMarshalClient(<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>&nbsp;toCheck)</pre>
<div class="block">Checks if this candidate matches an existing <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal"><code>NetMarshalClient</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>toCheck</code> - The client to check against.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If the candidate matches the passed client.</dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;o)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></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>Prev&nbsp;Class</li>
<li><a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/marshal/CandidateClient.html" target="_top">Frames</a></li>
<li><a href="CandidateClient.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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>

View File

@ -0,0 +1,462 @@
<!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>FragmentationOptions</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="FragmentationOptions";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":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/marshal/CandidateClient.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" target="_top">Frames</a></li>
<li><a href="FragmentationOptions.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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.marshal</div>
<h2 title="Class FragmentationOptions" class="title">Class FragmentationOptions</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.marshal.FragmentationOptions</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">FragmentationOptions</span>
extends java.lang.Object</pre>
<div class="block">This class provides fragmentation options for using <a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentSender</code></a>s and
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentReceiver</code></a>s in this package.</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">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#emptySendsTillForced">emptySendsTillForced</a></span></code>
<div class="block">See:
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setNumberOfEmptySendsTillForcedCompleteOrResend-int-"><code>FragmentReceiver.setNumberOfEmptySendsTillForcedCompleteOrResend(int)</code></a></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#equalityVerifyFragments">equalityVerifyFragments</a></span></code>
<div class="block">See:
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#setSentDataWillBeAllVerified-boolean-"><code>FragmentSender.setSentDataWillBeAllVerified(boolean)</code></a> ,
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setSentDataWillBeAllVerified-boolean-"><code>FragmentReceiver.setSentDataWillBeAllVerified(boolean)</code></a></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#fragmentationSplitSize">fragmentationSplitSize</a></span></code>
<div class="block">See:
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#setSplitSize-int-"><code>FragmentSender.setSplitSize(int)</code></a></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#maximumFragmentAge">maximumFragmentAge</a></span></code>
<div class="block">The maximum age of fragments for a specified packet in seconds before those fragments are purged.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#verifyFragments">verifyFragments</a></span></code>
<div class="block">See:
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#setResponseVerification-boolean-"><code>FragmentSender.setResponseVerification(boolean)</code></a> ,
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setResponseVerification-boolean-"><code>FragmentReceiver.setResponseVerification(boolean)</code></a></div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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/marshal/FragmentationOptions.html#FragmentationOptions--">FragmentationOptions</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#FragmentationOptions-com.captainalm.lib.calmnet.marshal.FragmentationOptions-">FragmentationOptions</a></span>(<a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a>&nbsp;toCopy)</code>
<div class="block">Creates a copy of the provided FragmentationOptions.</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#setupReceiver-com.captainalm.lib.calmnet.packet.fragment.FragmentReceiver-">setupReceiver</a></span>(<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a>&nbsp;receiver)</code>
<div class="block">Sets-up the provided <a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentReceiver</code></a> with parameters.</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/marshal/FragmentationOptions.html#setupSender-com.captainalm.lib.calmnet.packet.fragment.FragmentSender-">setupSender</a></span>(<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a>&nbsp;sender)</code>
<div class="block">Sets-up the provided <a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentSender</code></a> with parameters.</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/marshal/FragmentationOptions.html#validate--">validate</a></span>()</code>
<div class="block">Validates the parameters within this structure.</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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="maximumFragmentAge">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maximumFragmentAge</h4>
<pre>public&nbsp;int maximumFragmentAge</pre>
<div class="block">The maximum age of fragments for a specified packet in seconds before those fragments are purged.</div>
</li>
</ul>
<a name="fragmentationSplitSize">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fragmentationSplitSize</h4>
<pre>public&nbsp;int fragmentationSplitSize</pre>
<div class="block">See:
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#setSplitSize-int-"><code>FragmentSender.setSplitSize(int)</code></a></div>
</li>
</ul>
<a name="emptySendsTillForced">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>emptySendsTillForced</h4>
<pre>public&nbsp;int emptySendsTillForced</pre>
<div class="block">See:
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setNumberOfEmptySendsTillForcedCompleteOrResend-int-"><code>FragmentReceiver.setNumberOfEmptySendsTillForcedCompleteOrResend(int)</code></a></div>
</li>
</ul>
<a name="verifyFragments">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>verifyFragments</h4>
<pre>public&nbsp;boolean verifyFragments</pre>
<div class="block">See:
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#setResponseVerification-boolean-"><code>FragmentSender.setResponseVerification(boolean)</code></a> ,
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setResponseVerification-boolean-"><code>FragmentReceiver.setResponseVerification(boolean)</code></a></div>
</li>
</ul>
<a name="equalityVerifyFragments">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>equalityVerifyFragments</h4>
<pre>public&nbsp;boolean equalityVerifyFragments</pre>
<div class="block">See:
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#setSentDataWillBeAllVerified-boolean-"><code>FragmentSender.setSentDataWillBeAllVerified(boolean)</code></a> ,
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setSentDataWillBeAllVerified-boolean-"><code>FragmentReceiver.setSentDataWillBeAllVerified(boolean)</code></a></div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="FragmentationOptions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FragmentationOptions</h4>
<pre>public&nbsp;FragmentationOptions()</pre>
</li>
</ul>
<a name="FragmentationOptions-com.captainalm.lib.calmnet.marshal.FragmentationOptions-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FragmentationOptions</h4>
<pre>public&nbsp;FragmentationOptions(<a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a>&nbsp;toCopy)</pre>
<div class="block">Creates a copy of the provided FragmentationOptions.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>toCopy</code> - The options to copy.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - toCopy 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="validate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validate</h4>
<pre>public&nbsp;void&nbsp;validate()</pre>
<div class="block">Validates the parameters within this structure.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - maximumFragmentAge is less than 2, fragmentationSplitSize is less than 1 or emptySendsTillForced is less than 1.</dd>
</dl>
</li>
</ul>
<a name="setupSender-com.captainalm.lib.calmnet.packet.fragment.FragmentSender-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setupSender</h4>
<pre>public&nbsp;void&nbsp;setupSender(<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a>&nbsp;sender)</pre>
<div class="block">Sets-up the provided <a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentSender</code></a> with parameters.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sender</code> - The sender to set up.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - A parameter is incorrect.</dd>
</dl>
</li>
</ul>
<a name="setupReceiver-com.captainalm.lib.calmnet.packet.fragment.FragmentReceiver-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setupReceiver</h4>
<pre>public&nbsp;void&nbsp;setupReceiver(<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a>&nbsp;receiver)</pre>
<div class="block">Sets-up the provided <a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentReceiver</code></a> with parameters.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>receiver</code> - The receiver to set up.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - A parameter is incorrect.</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/marshal/CandidateClient.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" target="_top">Frames</a></li>
<li><a href="FragmentationOptions.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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>

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,491 @@
<!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>NetMarshalClientWrapped</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="NetMarshalClientWrapped";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":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/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/marshal/NetMarshalClientWrapped.html" target="_top">Frames</a></li>
<li><a href="NetMarshalClientWrapped.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.marshal</div>
<h2 title="Class NetMarshalClientWrapped" class="title">Class NetMarshalClientWrapped</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">com.captainalm.lib.calmnet.marshal.NetMarshalClient</a></li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.marshal.NetMarshalClientWrapped</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Closeable, java.lang.AutoCloseable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">NetMarshalClientWrapped</span>
extends <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></pre>
<div class="block">This class provides a managed way of networking on the client side, allows stream wrapping.
Wrapped streams should close the underlying stream when closed.
NOTE: Methods that are synchronised are used here, do NOT use instances of these classes as monitors.</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/marshal/NetMarshalClientWrapped.html#NetMarshalClientWrapped-java.net.DatagramSocket-java.net.InetAddress-int-java.io.InputStream-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-java.util.function.Function-java.util.function.Function-">NetMarshalClientWrapped</a></span>(java.net.DatagramSocket&nbsp;socketIn,
java.net.InetAddress&nbsp;remoteAddress,
int&nbsp;remotePort,
java.io.InputStream&nbsp;inputStream,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a>&nbsp;fragmentationOptions,
java.util.function.Function&lt;java.io.InputStream,java.io.InputStream&gt;&nbsp;inputStreamWrapper,
java.util.function.Function&lt;java.io.OutputStream,java.io.OutputStream&gt;&nbsp;outputStreamWrapper)</code>
<div class="block">Constructs a new NetMarshalClientWrapped with the specified <code>DatagramSocket</code>, remote <code>InetAddress</code>, remote port, <code>InputStream</code>, <a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>,
<a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>, <code>Function</code> for wrapping the input stream and the <code>Function</code> for wrapping the output stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClientWrapped.html#NetMarshalClientWrapped-java.net.DatagramSocket-java.net.InetAddress-int-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-java.util.function.Function-java.util.function.Function-">NetMarshalClientWrapped</a></span>(java.net.DatagramSocket&nbsp;socketIn,
java.net.InetAddress&nbsp;remoteAddress,
int&nbsp;remotePort,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a>&nbsp;fragmentationOptions,
java.util.function.Function&lt;java.io.InputStream,java.io.InputStream&gt;&nbsp;inputStreamWrapper,
java.util.function.Function&lt;java.io.OutputStream,java.io.OutputStream&gt;&nbsp;outputStreamWrapper)</code>
<div class="block">Constructs a new NetMarshalClientWrapped with the specified <code>DatagramSocket</code>, remote <code>InetAddress</code>, remote port, <a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>,
<a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>, <code>Function</code> for wrapping the input stream and the <code>Function</code> for wrapping the output stream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClientWrapped.html#NetMarshalClientWrapped-java.net.MulticastSocket-java.net.InetAddress-int-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-java.util.function.Function-java.util.function.Function-">NetMarshalClientWrapped</a></span>(java.net.MulticastSocket&nbsp;socketIn,
java.net.InetAddress&nbsp;multicastGroupAddress,
int&nbsp;multicastGroupPort,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a>&nbsp;fragmentationOptions,
java.util.function.Function&lt;java.io.InputStream,java.io.InputStream&gt;&nbsp;inputStreamWrapper,
java.util.function.Function&lt;java.io.OutputStream,java.io.OutputStream&gt;&nbsp;outputStreamWrapper)</code>
<div class="block">Constructs a new NetMarshalClientWrapped with the specified <code>MulticastSocket</code>, multicast group <code>InetAddress</code>, multicast port, <a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>,
<a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>, <code>Function</code> for wrapping the input stream and the <code>Function</code> for wrapping the output stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClientWrapped.html#NetMarshalClientWrapped-java.net.Socket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-java.util.function.Function-java.util.function.Function-">NetMarshalClientWrapped</a></span>(java.net.Socket&nbsp;socketIn,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a>&nbsp;fragmentationOptions,
java.util.function.Function&lt;java.io.InputStream,java.io.InputStream&gt;&nbsp;inputStreamWrapper,
java.util.function.Function&lt;java.io.OutputStream,java.io.OutputStream&gt;&nbsp;outputStreamWrapper)</code>
<div class="block">Constructs a new NetMarshalClientWrapped with the specified <code>Socket</code>, <a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>,
<a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>, <code>Function</code> for wrapping the input stream and the <code>Function</code> for wrapping the output stream.</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>java.util.function.Function&lt;java.io.InputStream,java.io.InputStream&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClientWrapped.html#getWrapperInputStream--">getWrapperInputStream</a></span>()</code>
<div class="block">Gets the <code>Function</code> input stream wrapper function.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.function.Function&lt;java.io.OutputStream,java.io.OutputStream&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClientWrapped.html#getWrapperOutputStream--">getWrapperOutputStream</a></span>()</code>
<div class="block">Gets the <code>Function</code> output stream wrapper function.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.captainalm.lib.calmnet.marshal.NetMarshalClient">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.captainalm.lib.calmnet.marshal.<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></h3>
<code><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#arePacketsBeingRead--">arePacketsBeingRead</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#areReceivedPacketsWaiting--">areReceivedPacketsWaiting</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#clearFragmentStorage--">clearFragmentStorage</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#close--">close</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#flush--">flush</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#getClosedConsumer--">getClosedConsumer</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#getFragmentationOptions--">getFragmentationOptions</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#getInputStream--">getInputStream</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#getOutputStream--">getOutputStream</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#getPacketFactory--">getPacketFactory</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#getPacketLoader--">getPacketLoader</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#getReceiveBiConsumer--">getReceiveBiConsumer</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#getReceiveExceptionBiConsumer--">getReceiveExceptionBiConsumer</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#getRootInputStream--">getRootInputStream</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#getRootOutputStream--">getRootOutputStream</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#isRunning--">isRunning</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#isSSLUpgraded--">isSSLUpgraded</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#localAddress--">localAddress</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#localPort--">localPort</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#open--">open</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#receivePacket--">receivePacket</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#receivePacketPolled--">receivePacketPolled</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#remoteAddress--">remoteAddress</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#remotePort--">remotePort</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#sendPacket-com.captainalm.lib.calmnet.packet.IPacket-boolean-">sendPacket</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#setClosedConsumer-java.util.function.Consumer-">setClosedConsumer</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#setPacketsShouldBeRead-boolean-">setPacketsShouldBeRead</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#setReceiveBiConsumer-java.util.function.BiConsumer-">setReceiveBiConsumer</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#setReceiveExceptionBiConsumer-java.util.function.BiConsumer-">setReceiveExceptionBiConsumer</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#sslUpgradeClientSide-javax.net.ssl.SSLContext-java.lang.String-">sslUpgradeClientSide</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#sslUpgradeServerSide-javax.net.ssl.SSLContext-">sslUpgradeServerSide</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&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="NetMarshalClientWrapped-java.net.Socket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-java.util.function.Function-java.util.function.Function-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NetMarshalClientWrapped</h4>
<pre>public&nbsp;NetMarshalClientWrapped(java.net.Socket&nbsp;socketIn,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a>&nbsp;fragmentationOptions,
java.util.function.Function&lt;java.io.InputStream,java.io.InputStream&gt;&nbsp;inputStreamWrapper,
java.util.function.Function&lt;java.io.OutputStream,java.io.OutputStream&gt;&nbsp;outputStreamWrapper)</pre>
<div class="block">Constructs a new NetMarshalClientWrapped with the specified <code>Socket</code>, <a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>,
<a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>, <code>Function</code> for wrapping the input stream and the <code>Function</code> for wrapping the output stream.
Wrapped streams should close the underlying stream when closed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>socketIn</code> - The socket to use.</dd>
<dd><code>factory</code> - The packet factory to use.</dd>
<dd><code>loader</code> - The packet loader to use.</dd>
<dd><code>fragmentationOptions</code> - The fragmentation options, null to disable fragmentation.</dd>
<dd><code>inputStreamWrapper</code> - The input stream wrapper to use (Can be null).</dd>
<dd><code>outputStreamWrapper</code> - The output stream wrapper to use (Can be null).</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - socketIn, factory or loader is null.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - Fragmentation options failed validation.</dd>
</dl>
</li>
</ul>
<a name="NetMarshalClientWrapped-java.net.MulticastSocket-java.net.InetAddress-int-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-java.util.function.Function-java.util.function.Function-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NetMarshalClientWrapped</h4>
<pre>public&nbsp;NetMarshalClientWrapped(java.net.MulticastSocket&nbsp;socketIn,
java.net.InetAddress&nbsp;multicastGroupAddress,
int&nbsp;multicastGroupPort,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a>&nbsp;fragmentationOptions,
java.util.function.Function&lt;java.io.InputStream,java.io.InputStream&gt;&nbsp;inputStreamWrapper,
java.util.function.Function&lt;java.io.OutputStream,java.io.OutputStream&gt;&nbsp;outputStreamWrapper)
throws java.io.IOException</pre>
<div class="block">Constructs a new NetMarshalClientWrapped with the specified <code>MulticastSocket</code>, multicast group <code>InetAddress</code>, multicast port, <a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>,
<a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>, <code>Function</code> for wrapping the input stream and the <code>Function</code> for wrapping the output stream.
The <code>MulticastSocket</code> will join the multicast group.
Wrapped streams should close the underlying stream when closed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>socketIn</code> - The multicast socket to use.</dd>
<dd><code>multicastGroupAddress</code> - The multicast group address.</dd>
<dd><code>multicastGroupPort</code> - The multicast group port.</dd>
<dd><code>factory</code> - The packet factory to use.</dd>
<dd><code>loader</code> - The packet loader to use.</dd>
<dd><code>fragmentationOptions</code> - The fragmentation options, null to disable fragmentation.</dd>
<dd><code>inputStreamWrapper</code> - The input stream wrapper to use (Can be null).</dd>
<dd><code>outputStreamWrapper</code> - The output stream wrapper to use (Can be null).</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - There is an error joining or multicastGroupAddress is not a multicast address.</dd>
<dd><code>java.lang.NullPointerException</code> - socketIn, multicastGroupAddress, factory or loader is null.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - multicastGroupPort is less than 0 or greater than 65535 or fragmentation options failed validation.</dd>
</dl>
</li>
</ul>
<a name="NetMarshalClientWrapped-java.net.DatagramSocket-java.net.InetAddress-int-java.io.InputStream-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-java.util.function.Function-java.util.function.Function-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NetMarshalClientWrapped</h4>
<pre>public&nbsp;NetMarshalClientWrapped(java.net.DatagramSocket&nbsp;socketIn,
java.net.InetAddress&nbsp;remoteAddress,
int&nbsp;remotePort,
java.io.InputStream&nbsp;inputStream,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a>&nbsp;fragmentationOptions,
java.util.function.Function&lt;java.io.InputStream,java.io.InputStream&gt;&nbsp;inputStreamWrapper,
java.util.function.Function&lt;java.io.OutputStream,java.io.OutputStream&gt;&nbsp;outputStreamWrapper)</pre>
<div class="block">Constructs a new NetMarshalClientWrapped with the specified <code>DatagramSocket</code>, remote <code>InetAddress</code>, remote port, <code>InputStream</code>, <a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>,
<a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>, <code>Function</code> for wrapping the input stream and the <code>Function</code> for wrapping the output stream.
Wrapped streams should close the underlying stream when closed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>socketIn</code> - The datagram socket to use.</dd>
<dd><code>remoteAddress</code> - The remote address to send data to.</dd>
<dd><code>remotePort</code> - The remote port to send data to.</dd>
<dd><code>inputStream</code> - The receiving input stream.</dd>
<dd><code>factory</code> - The packet factory to use.</dd>
<dd><code>loader</code> - The loader to use.</dd>
<dd><code>fragmentationOptions</code> - The fragmentation options, null to disable fragmentation.</dd>
<dd><code>inputStreamWrapper</code> - The input stream wrapper to use (Can be null).</dd>
<dd><code>outputStreamWrapper</code> - The output stream wrapper to use (Can be null).</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - socketIn, remoteAddress, inputStream, factory or loader is null.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - remotePort is less than 0 or greater than 65535 or fragmentation options failed validation.</dd>
</dl>
</li>
</ul>
<a name="NetMarshalClientWrapped-java.net.DatagramSocket-java.net.InetAddress-int-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-java.util.function.Function-java.util.function.Function-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NetMarshalClientWrapped</h4>
<pre>public&nbsp;NetMarshalClientWrapped(java.net.DatagramSocket&nbsp;socketIn,
java.net.InetAddress&nbsp;remoteAddress,
int&nbsp;remotePort,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a>&nbsp;fragmentationOptions,
java.util.function.Function&lt;java.io.InputStream,java.io.InputStream&gt;&nbsp;inputStreamWrapper,
java.util.function.Function&lt;java.io.OutputStream,java.io.OutputStream&gt;&nbsp;outputStreamWrapper)</pre>
<div class="block">Constructs a new NetMarshalClientWrapped with the specified <code>DatagramSocket</code>, remote <code>InetAddress</code>, remote port, <a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>,
<a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>, <code>Function</code> for wrapping the input stream and the <code>Function</code> for wrapping the output stream.
Wrapped streams should close the underlying stream when closed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>socketIn</code> - The datagram socket to use.</dd>
<dd><code>remoteAddress</code> - The remote address to send data to.</dd>
<dd><code>remotePort</code> - The remote port to send data to.</dd>
<dd><code>factory</code> - The packet factory to use.</dd>
<dd><code>loader</code> - The loader to use.</dd>
<dd><code>fragmentationOptions</code> - The fragmentation options, null to disable fragmentation.</dd>
<dd><code>inputStreamWrapper</code> - The input stream wrapper to use (Can be null).</dd>
<dd><code>outputStreamWrapper</code> - The output stream wrapper to use (Can be null).</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - socketIn, remoteAddress, factory or loader is null.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - remotePort is less than 0 or greater than 65535 or fragmentation options failed validation.</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="getWrapperInputStream--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWrapperInputStream</h4>
<pre>public&nbsp;java.util.function.Function&lt;java.io.InputStream,java.io.InputStream&gt;&nbsp;getWrapperInputStream()</pre>
<div class="block">Gets the <code>Function</code> input stream wrapper function.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The input stream wrapper function or null.</dd>
</dl>
</li>
</ul>
<a name="getWrapperOutputStream--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getWrapperOutputStream</h4>
<pre>public&nbsp;java.util.function.Function&lt;java.io.OutputStream,java.io.OutputStream&gt;&nbsp;getWrapperOutputStream()</pre>
<div class="block">Gets the <code>Function</code> output stream wrapper function.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The output stream wrapper function or null.</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/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/marshal/NetMarshalClientWrapped.html" target="_top">Frames</a></li>
<li><a href="NetMarshalClientWrapped.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>

View File

@ -0,0 +1,902 @@
<!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>NetMarshalServer</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="NetMarshalServer";
}
}
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,"i24":10,"i25":10,"i26":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/marshal/NetMarshalClientWrapped.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServerWrapped.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" target="_top">Frames</a></li>
<li><a href="NetMarshalServer.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.marshal</div>
<h2 title="Class NetMarshalServer" class="title">Class NetMarshalServer</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.marshal.NetMarshalServer</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Closeable, java.lang.AutoCloseable</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServerWrapped.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServerWrapped</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">NetMarshalServer</span>
extends java.lang.Object
implements java.io.Closeable</pre>
<div class="block">This class provides a way of networking on the server side and holds a collection of <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal"><code>NetMarshalClient</code></a>s.
NOTE: Methods that are synchronised are used here, do NOT use instances of these classes as monitors.</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/marshal/NetMarshalServer.html#NetMarshalServer-java.net.DatagramSocket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-">NetMarshalServer</a></span>(java.net.DatagramSocket&nbsp;socketIn,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a>&nbsp;fragmentationOptions)</code>
<div class="block">Constructs a new NetMarshalServer with the specified <code>DatagramSocket</code>, <a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#NetMarshalServer-java.net.ServerSocket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-">NetMarshalServer</a></span>(java.net.ServerSocket&nbsp;socketIn,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a>&nbsp;fragmentationOptions)</code>
<div class="block">Constructs a new NetMarshalServer with the specified <code>ServerSocket</code>, <a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#broadcastPacket-com.captainalm.lib.calmnet.packet.IPacket-boolean-">broadcastPacket</a></span>(<a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packetIn,
boolean&nbsp;directSend)</code>
<div class="block">Broadcasts a <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>.</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/marshal/NetMarshalServer.html#close--">close</a></span>()</code>
<div class="block">Closes the marshal, closing all the connected clients.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#connect-java.net.InetAddress-int-int-">connect</a></span>(java.net.InetAddress&nbsp;remoteAddress,
int&nbsp;remotePort,
int&nbsp;timeout)</code>
<div class="block">Connects to a remote endpoint.</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/marshal/NetMarshalServer.html#disconnectAll--">disconnectAll</a></span>()</code>
<div class="block">Disconnects all the clients (By closing them).</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/marshal/NetMarshalServer.html#flush--">flush</a></span>()</code>
<div class="block">Flushes all the output streams on all the clients.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.function.BiConsumer&lt;java.lang.Exception,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getAcceptExceptionBiConsumer--">getAcceptExceptionBiConsumer</a></span>()</code>
<div class="block">Gets the <code>BiConsumer</code> accept exception consumer.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.util.function.BiConsumer&lt;<a href="../../../../../com/captainalm/lib/calmnet/marshal/CandidateClient.html" title="class in com.captainalm.lib.calmnet.marshal">CandidateClient</a>,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getClientAcceptanceBiConsumer--">getClientAcceptanceBiConsumer</a></span>()</code>
<div class="block">Gets the <code>BiConsumer</code> client acceptance consumer.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.util.function.Consumer&lt;<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getClosedConsumer--">getClosedConsumer</a></span>()</code>
<div class="block">Gets the <code>Consumer</code> closed consumer.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getConnectedClients--">getConnectedClients</a></span>()</code>
<div class="block">Gets the current set of connected <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal"><code>NetMarshalClient</code></a>s.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getFragmentationOptions--">getFragmentationOptions</a></span>()</code>
<div class="block">Gets the <a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a> of the client.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.util.function.Consumer&lt;<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getOpenedConsumer--">getOpenedConsumer</a></span>()</code>
<div class="block">Gets the <code>Consumer</code> opened consumer.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<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/marshal/NetMarshalServer.html#getPacketFactory--">getPacketFactory</a></span>()</code>
<div class="block">Gets the packet factory in use.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<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/marshal/NetMarshalServer.html#getPacketLoader--">getPacketLoader</a></span>()</code>
<div class="block">Gets the packet loader in use.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.util.function.BiConsumer&lt;<a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getReceiveBiConsumer--">getReceiveBiConsumer</a></span>()</code>
<div class="block">Gets the <code>BiConsumer</code> receiver consumer.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.util.function.BiConsumer&lt;java.lang.Exception,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getReceiveExceptionBiConsumer--">getReceiveExceptionBiConsumer</a></span>()</code>
<div class="block">Gets the <code>BiConsumer</code> receive exception consumer.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>java.util.function.BiConsumer&lt;java.net.Socket,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getSocketSetupBiConsumer--">getSocketSetupBiConsumer</a></span>()</code>
<div class="block">Gets the <code>BiConsumer</code> socket setup consumer.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#isRunning--">isRunning</a></span>()</code>
<div class="block">Gets if the marshal is running.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>java.net.InetAddress</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#localAddress--">localAddress</a></span>()</code>
<div class="block">Get the local <code>InetAddress</code>.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#localPort--">localPort</a></span>()</code>
<div class="block">Get the local port.</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/marshal/NetMarshalServer.html#open--">open</a></span>()</code>
<div class="block">Opens the marshal.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#setAcceptExceptionBiConsumer-java.util.function.BiConsumer-">setAcceptExceptionBiConsumer</a></span>(java.util.function.BiConsumer&lt;java.lang.Exception,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a>&gt;&nbsp;consumer)</code>
<div class="block">Sets the <code>BiConsumer</code> accept exception consumer.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#setClientAcceptanceBiConsumer-java.util.function.BiConsumer-">setClientAcceptanceBiConsumer</a></span>(java.util.function.BiConsumer&lt;<a href="../../../../../com/captainalm/lib/calmnet/marshal/CandidateClient.html" title="class in com.captainalm.lib.calmnet.marshal">CandidateClient</a>,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a>&gt;&nbsp;consumer)</code>
<div class="block">Sets the <code>BiConsumer</code> client acceptance consumer.</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/marshal/NetMarshalServer.html#setClosedConsumer-java.util.function.Consumer-">setClosedConsumer</a></span>(java.util.function.Consumer&lt;<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>&gt;&nbsp;consumer)</code>
<div class="block">Sets the <code>Consumer</code> closed consumer.</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/marshal/NetMarshalServer.html#setOpenedConsumer-java.util.function.Consumer-">setOpenedConsumer</a></span>(java.util.function.Consumer&lt;<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>&gt;&nbsp;consumer)</code>
<div class="block">Sets the <code>Consumer</code> opened consumer.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#setReceiveBiConsumer-java.util.function.BiConsumer-">setReceiveBiConsumer</a></span>(java.util.function.BiConsumer&lt;<a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>&gt;&nbsp;consumer)</code>
<div class="block">Sets the <code>BiConsumer</code> receiver consumer.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#setReceiveExceptionBiConsumer-java.util.function.BiConsumer-">setReceiveExceptionBiConsumer</a></span>(java.util.function.BiConsumer&lt;java.lang.Exception,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>&gt;&nbsp;consumer)</code>
<div class="block">Sets the <code>BiConsumer</code> receive exception consumer.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#setSocketSetupBiConsumer-java.util.function.BiConsumer-">setSocketSetupBiConsumer</a></span>(java.util.function.BiConsumer&lt;java.net.Socket,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a>&gt;&nbsp;consumer)</code>
<div class="block">Sets the <code>BiConsumer</code> socket setup consumer.</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="NetMarshalServer-java.net.ServerSocket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NetMarshalServer</h4>
<pre>public&nbsp;NetMarshalServer(java.net.ServerSocket&nbsp;socketIn,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a>&nbsp;fragmentationOptions)</pre>
<div class="block">Constructs a new NetMarshalServer with the specified <code>ServerSocket</code>, <a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>socketIn</code> - The server socket to use.</dd>
<dd><code>factory</code> - The packet factory to use.</dd>
<dd><code>loader</code> - The packet loader to use.</dd>
<dd><code>fragmentationOptions</code> - The fragmentation options, null to disable fragmentation.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - socketIn, factory or loader is null.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - Fragmentation options failed validation.</dd>
</dl>
</li>
</ul>
<a name="NetMarshalServer-java.net.DatagramSocket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NetMarshalServer</h4>
<pre>public&nbsp;NetMarshalServer(java.net.DatagramSocket&nbsp;socketIn,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a>&nbsp;fragmentationOptions)</pre>
<div class="block">Constructs a new NetMarshalServer with the specified <code>DatagramSocket</code>, <a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>socketIn</code> - The datagram socket to use.</dd>
<dd><code>factory</code> - The packet factory to use.</dd>
<dd><code>loader</code> - The packet loader to use.</dd>
<dd><code>fragmentationOptions</code> - The fragmentation options, null to disable fragmentation.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - socketIn, factory or loader is null.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - Fragmentation options failed validation.</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="open--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>open</h4>
<pre>public final&nbsp;void&nbsp;open()</pre>
<div class="block">Opens the marshal.</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 packet factory in use.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The packet factory.</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 packet loader in use.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The packet loader.</dd>
</dl>
</li>
</ul>
<a name="localAddress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>localAddress</h4>
<pre>public&nbsp;java.net.InetAddress&nbsp;localAddress()</pre>
<div class="block">Get the local <code>InetAddress</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The local address or null.</dd>
</dl>
</li>
</ul>
<a name="localPort--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>localPort</h4>
<pre>public&nbsp;int&nbsp;localPort()</pre>
<div class="block">Get the local port.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The local port or -1.</dd>
</dl>
</li>
</ul>
<a name="isRunning--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRunning</h4>
<pre>public final&nbsp;boolean&nbsp;isRunning()</pre>
<div class="block">Gets if the marshal is running.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If the marshal is running.</dd>
</dl>
</li>
</ul>
<a name="getFragmentationOptions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFragmentationOptions</h4>
<pre>public&nbsp;<a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a>&nbsp;getFragmentationOptions()</pre>
<div class="block">Gets the <a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a> of the client.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The fragmentation options or null if fragmentation is disabled.</dd>
</dl>
</li>
</ul>
<a name="getConnectedClients--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnectedClients</h4>
<pre>public final&nbsp;<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>[]&nbsp;getConnectedClients()</pre>
<div class="block">Gets the current set of connected <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal"><code>NetMarshalClient</code></a>s.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An array of connected clients.</dd>
</dl>
</li>
</ul>
<a name="broadcastPacket-com.captainalm.lib.calmnet.packet.IPacket-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>broadcastPacket</h4>
<pre>public final&nbsp;void&nbsp;broadcastPacket(<a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packetIn,
boolean&nbsp;directSend)
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">Broadcasts a <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>packetIn</code> - The packet to broadcast.</dd>
<dd><code>directSend</code> - Whether the packet should be sent directly or through the fragmentation system.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - A stream 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>
<dd><code>java.lang.NullPointerException</code> - packetIn is null.</dd>
</dl>
</li>
</ul>
<a name="flush--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flush</h4>
<pre>public final&nbsp;void&nbsp;flush()
throws java.io.IOException</pre>
<div class="block">Flushes all the output streams on all the clients.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - A stream exception has occurred.</dd>
</dl>
</li>
</ul>
<a name="disconnectAll--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disconnectAll</h4>
<pre>public final&nbsp;void&nbsp;disconnectAll()
throws java.io.IOException</pre>
<div class="block">Disconnects all the clients (By closing them).</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - An I/O Exception has occurred.</dd>
</dl>
</li>
</ul>
<a name="getReceiveBiConsumer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReceiveBiConsumer</h4>
<pre>public&nbsp;java.util.function.BiConsumer&lt;<a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>&gt;&nbsp;getReceiveBiConsumer()</pre>
<div class="block">Gets the <code>BiConsumer</code> receiver consumer.
WARNING: Calling <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#broadcastPacket-com.captainalm.lib.calmnet.packet.IPacket-boolean-"><code>broadcastPacket(IPacket, boolean)</code></a> or <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#flush--"><code>flush()</code></a> could cause full buffer hangs.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The receiver consumer or null.</dd>
</dl>
</li>
</ul>
<a name="setReceiveBiConsumer-java.util.function.BiConsumer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReceiveBiConsumer</h4>
<pre>public&nbsp;void&nbsp;setReceiveBiConsumer(java.util.function.BiConsumer&lt;<a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>&gt;&nbsp;consumer)</pre>
<div class="block">Sets the <code>BiConsumer</code> receiver consumer.
WARNING: Calling <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#broadcastPacket-com.captainalm.lib.calmnet.packet.IPacket-boolean-"><code>broadcastPacket(IPacket, boolean)</code></a> or <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#flush--"><code>flush()</code></a> could cause full buffer hangs.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>consumer</code> - The new receiver consumer.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - consumer is null.</dd>
</dl>
</li>
</ul>
<a name="getReceiveExceptionBiConsumer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReceiveExceptionBiConsumer</h4>
<pre>public&nbsp;java.util.function.BiConsumer&lt;java.lang.Exception,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>&gt;&nbsp;getReceiveExceptionBiConsumer()</pre>
<div class="block">Gets the <code>BiConsumer</code> receive exception consumer.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The exception consumer or null.</dd>
</dl>
</li>
</ul>
<a name="setReceiveExceptionBiConsumer-java.util.function.BiConsumer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReceiveExceptionBiConsumer</h4>
<pre>public&nbsp;void&nbsp;setReceiveExceptionBiConsumer(java.util.function.BiConsumer&lt;java.lang.Exception,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>&gt;&nbsp;consumer)</pre>
<div class="block">Sets the <code>BiConsumer</code> receive exception consumer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>consumer</code> - The new exception consumer.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - consumer is null.</dd>
</dl>
</li>
</ul>
<a name="getAcceptExceptionBiConsumer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAcceptExceptionBiConsumer</h4>
<pre>public&nbsp;java.util.function.BiConsumer&lt;java.lang.Exception,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a>&gt;&nbsp;getAcceptExceptionBiConsumer()</pre>
<div class="block">Gets the <code>BiConsumer</code> accept exception consumer.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The exception consumer or null.</dd>
</dl>
</li>
</ul>
<a name="setAcceptExceptionBiConsumer-java.util.function.BiConsumer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAcceptExceptionBiConsumer</h4>
<pre>public&nbsp;void&nbsp;setAcceptExceptionBiConsumer(java.util.function.BiConsumer&lt;java.lang.Exception,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a>&gt;&nbsp;consumer)</pre>
<div class="block">Sets the <code>BiConsumer</code> accept exception consumer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>consumer</code> - The new exception consumer.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - consumer is null.</dd>
</dl>
</li>
</ul>
<a name="getClosedConsumer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClosedConsumer</h4>
<pre>public&nbsp;java.util.function.Consumer&lt;<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>&gt;&nbsp;getClosedConsumer()</pre>
<div class="block">Gets the <code>Consumer</code> closed consumer.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The closed consumer or null.</dd>
</dl>
</li>
</ul>
<a name="setClosedConsumer-java.util.function.Consumer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setClosedConsumer</h4>
<pre>public&nbsp;void&nbsp;setClosedConsumer(java.util.function.Consumer&lt;<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>&gt;&nbsp;consumer)</pre>
<div class="block">Sets the <code>Consumer</code> closed consumer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>consumer</code> - The new closed consumer.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - consumer is null.</dd>
</dl>
</li>
</ul>
<a name="getOpenedConsumer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOpenedConsumer</h4>
<pre>public&nbsp;java.util.function.Consumer&lt;<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>&gt;&nbsp;getOpenedConsumer()</pre>
<div class="block">Gets the <code>Consumer</code> opened consumer.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The opened consumer or null.</dd>
</dl>
</li>
</ul>
<a name="setOpenedConsumer-java.util.function.Consumer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOpenedConsumer</h4>
<pre>public&nbsp;void&nbsp;setOpenedConsumer(java.util.function.Consumer&lt;<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>&gt;&nbsp;consumer)</pre>
<div class="block">Sets the <code>Consumer</code> opened consumer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>consumer</code> - The new opened consumer.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - consumer is null.</dd>
</dl>
</li>
</ul>
<a name="getClientAcceptanceBiConsumer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClientAcceptanceBiConsumer</h4>
<pre>public&nbsp;java.util.function.BiConsumer&lt;<a href="../../../../../com/captainalm/lib/calmnet/marshal/CandidateClient.html" title="class in com.captainalm.lib.calmnet.marshal">CandidateClient</a>,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a>&gt;&nbsp;getClientAcceptanceBiConsumer()</pre>
<div class="block">Gets the <code>BiConsumer</code> client acceptance consumer.
Use <a href="../../../../../com/captainalm/lib/calmnet/marshal/CandidateClient.html#accept"><code>CandidateClient.accept</code></a> to declare whether the candidate should be accepted.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The acceptance consumer or null.</dd>
</dl>
</li>
</ul>
<a name="setClientAcceptanceBiConsumer-java.util.function.BiConsumer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setClientAcceptanceBiConsumer</h4>
<pre>public&nbsp;void&nbsp;setClientAcceptanceBiConsumer(java.util.function.BiConsumer&lt;<a href="../../../../../com/captainalm/lib/calmnet/marshal/CandidateClient.html" title="class in com.captainalm.lib.calmnet.marshal">CandidateClient</a>,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a>&gt;&nbsp;consumer)</pre>
<div class="block">Sets the <code>BiConsumer</code> client acceptance consumer.
Use <a href="../../../../../com/captainalm/lib/calmnet/marshal/CandidateClient.html#accept"><code>CandidateClient.accept</code></a> to declare whether the candidate should be accepted.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>consumer</code> - The new acceptance consumer.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - consumer is null.</dd>
</dl>
</li>
</ul>
<a name="getSocketSetupBiConsumer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSocketSetupBiConsumer</h4>
<pre>public&nbsp;java.util.function.BiConsumer&lt;java.net.Socket,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a>&gt;&nbsp;getSocketSetupBiConsumer()</pre>
<div class="block">Gets the <code>BiConsumer</code> socket setup consumer.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The setup consumer or null.</dd>
</dl>
</li>
</ul>
<a name="setSocketSetupBiConsumer-java.util.function.BiConsumer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSocketSetupBiConsumer</h4>
<pre>public&nbsp;void&nbsp;setSocketSetupBiConsumer(java.util.function.BiConsumer&lt;java.net.Socket,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a>&gt;&nbsp;consumer)</pre>
<div class="block">Sets the <code>BiConsumer</code> socket setup consumer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>consumer</code> - The new setup consumer.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - consumer is null.</dd>
</dl>
</li>
</ul>
<a name="connect-java.net.InetAddress-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connect</h4>
<pre>public final&nbsp;<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>&nbsp;connect(java.net.InetAddress&nbsp;remoteAddress,
int&nbsp;remotePort,
int&nbsp;timeout)
throws java.io.IOException</pre>
<div class="block">Connects to a remote endpoint.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>remoteAddress</code> - The remote address to connect to.</dd>
<dd><code>remotePort</code> - The remote port to connect to.</dd>
<dd><code>timeout</code> - The timeout of the connection attempt (0 for infinite timeout).</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A NetMarshalClient instance or null for non-accepted connection.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - A connection error has occurred.</dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>public final&nbsp;void&nbsp;close()
throws java.io.IOException</pre>
<div class="block">Closes the marshal, closing all the connected clients.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.io.Closeable</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - An I/O 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/marshal/NetMarshalClientWrapped.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServerWrapped.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" target="_top">Frames</a></li>
<li><a href="NetMarshalServer.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>

View File

@ -0,0 +1,385 @@
<!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>NetMarshalServerWrapped</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="NetMarshalServerWrapped";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":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/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/marshal/NetMarshalServerWrapped.html" target="_top">Frames</a></li>
<li><a href="NetMarshalServerWrapped.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.marshal</div>
<h2 title="Class NetMarshalServerWrapped" class="title">Class NetMarshalServerWrapped</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">com.captainalm.lib.calmnet.marshal.NetMarshalServer</a></li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.marshal.NetMarshalServerWrapped</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Closeable, java.lang.AutoCloseable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">NetMarshalServerWrapped</span>
extends <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></pre>
<div class="block">This class provides a way of networking on the server side and holds a collection of <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal"><code>NetMarshalClient</code></a>s, allows stream wrapping.
Wrapped streams should close the underlying stream when closed.
NOTE: Methods that are synchronised are used here, do NOT use instances of these classes as monitors.</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/marshal/NetMarshalServerWrapped.html#NetMarshalServerWrapped-java.net.DatagramSocket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-java.util.function.Function-java.util.function.Function-">NetMarshalServerWrapped</a></span>(java.net.DatagramSocket&nbsp;socketIn,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a>&nbsp;fragmentationOptions,
java.util.function.Function&lt;java.io.InputStream,java.io.InputStream&gt;&nbsp;inputStreamWrapper,
java.util.function.Function&lt;java.io.OutputStream,java.io.OutputStream&gt;&nbsp;outputStreamWrapper)</code>
<div class="block">Constructs a new NetMarshalServerWrapped with the specified <code>DatagramSocket</code>, <a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>,
<code>Function</code> for wrapping the input stream and the <code>Function</code> for wrapping the output stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServerWrapped.html#NetMarshalServerWrapped-java.net.ServerSocket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-java.util.function.Function-java.util.function.Function-">NetMarshalServerWrapped</a></span>(java.net.ServerSocket&nbsp;socketIn,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a>&nbsp;fragmentationOptions,
java.util.function.Function&lt;java.io.InputStream,java.io.InputStream&gt;&nbsp;inputStreamWrapper,
java.util.function.Function&lt;java.io.OutputStream,java.io.OutputStream&gt;&nbsp;outputStreamWrapper)</code>
<div class="block">Constructs a new NetMarshalServerWrapped with the specified <code>ServerSocket</code>, <a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>,
<code>Function</code> for wrapping the input stream and the <code>Function</code> for wrapping the output stream.</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>java.util.function.Function&lt;java.io.InputStream,java.io.InputStream&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServerWrapped.html#getWrapperInputStream--">getWrapperInputStream</a></span>()</code>
<div class="block">Gets the <code>Function</code> input stream wrapper function.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.function.Function&lt;java.io.OutputStream,java.io.OutputStream&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServerWrapped.html#getWrapperOutputStream--">getWrapperOutputStream</a></span>()</code>
<div class="block">Gets the <code>Function</code> output stream wrapper function.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.captainalm.lib.calmnet.marshal.NetMarshalServer">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.captainalm.lib.calmnet.marshal.<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></h3>
<code><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#broadcastPacket-com.captainalm.lib.calmnet.packet.IPacket-boolean-">broadcastPacket</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#close--">close</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#connect-java.net.InetAddress-int-int-">connect</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#disconnectAll--">disconnectAll</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#flush--">flush</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getAcceptExceptionBiConsumer--">getAcceptExceptionBiConsumer</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getClientAcceptanceBiConsumer--">getClientAcceptanceBiConsumer</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getClosedConsumer--">getClosedConsumer</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getConnectedClients--">getConnectedClients</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getFragmentationOptions--">getFragmentationOptions</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getOpenedConsumer--">getOpenedConsumer</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getPacketFactory--">getPacketFactory</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getPacketLoader--">getPacketLoader</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getReceiveBiConsumer--">getReceiveBiConsumer</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getReceiveExceptionBiConsumer--">getReceiveExceptionBiConsumer</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getSocketSetupBiConsumer--">getSocketSetupBiConsumer</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#isRunning--">isRunning</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#localAddress--">localAddress</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#localPort--">localPort</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#open--">open</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#setAcceptExceptionBiConsumer-java.util.function.BiConsumer-">setAcceptExceptionBiConsumer</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#setClientAcceptanceBiConsumer-java.util.function.BiConsumer-">setClientAcceptanceBiConsumer</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#setClosedConsumer-java.util.function.Consumer-">setClosedConsumer</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#setOpenedConsumer-java.util.function.Consumer-">setOpenedConsumer</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#setReceiveBiConsumer-java.util.function.BiConsumer-">setReceiveBiConsumer</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#setReceiveExceptionBiConsumer-java.util.function.BiConsumer-">setReceiveExceptionBiConsumer</a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#setSocketSetupBiConsumer-java.util.function.BiConsumer-">setSocketSetupBiConsumer</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&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="NetMarshalServerWrapped-java.net.ServerSocket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-java.util.function.Function-java.util.function.Function-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NetMarshalServerWrapped</h4>
<pre>public&nbsp;NetMarshalServerWrapped(java.net.ServerSocket&nbsp;socketIn,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a>&nbsp;fragmentationOptions,
java.util.function.Function&lt;java.io.InputStream,java.io.InputStream&gt;&nbsp;inputStreamWrapper,
java.util.function.Function&lt;java.io.OutputStream,java.io.OutputStream&gt;&nbsp;outputStreamWrapper)</pre>
<div class="block">Constructs a new NetMarshalServerWrapped with the specified <code>ServerSocket</code>, <a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>,
<code>Function</code> for wrapping the input stream and the <code>Function</code> for wrapping the output stream.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>socketIn</code> - The server socket to use.</dd>
<dd><code>factory</code> - The packet factory to use.</dd>
<dd><code>loader</code> - The packet loader to use.</dd>
<dd><code>fragmentationOptions</code> - The fragmentation options, null to disable fragmentation.</dd>
<dd><code>inputStreamWrapper</code> - The input stream wrapper to use (Can be null).</dd>
<dd><code>outputStreamWrapper</code> - The output stream wrapper to use (Can be null).</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - socketIn, factory or loader is null.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - Fragmentation options failed validation.</dd>
</dl>
</li>
</ul>
<a name="NetMarshalServerWrapped-java.net.DatagramSocket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-java.util.function.Function-java.util.function.Function-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NetMarshalServerWrapped</h4>
<pre>public&nbsp;NetMarshalServerWrapped(java.net.DatagramSocket&nbsp;socketIn,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a>&nbsp;fragmentationOptions,
java.util.function.Function&lt;java.io.InputStream,java.io.InputStream&gt;&nbsp;inputStreamWrapper,
java.util.function.Function&lt;java.io.OutputStream,java.io.OutputStream&gt;&nbsp;outputStreamWrapper)</pre>
<div class="block">Constructs a new NetMarshalServerWrapped with the specified <code>DatagramSocket</code>, <a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>,
<code>Function</code> for wrapping the input stream and the <code>Function</code> for wrapping the output stream.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>socketIn</code> - The datagram socket to use.</dd>
<dd><code>factory</code> - The packet factory to use.</dd>
<dd><code>loader</code> - The packet loader to use.</dd>
<dd><code>fragmentationOptions</code> - The fragmentation options, null to disable fragmentation.</dd>
<dd><code>inputStreamWrapper</code> - The input stream wrapper to use (Can be null).</dd>
<dd><code>outputStreamWrapper</code> - The output stream wrapper to use (Can be null).</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - socketIn, factory or loader is null.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - Fragmentation options failed validation.</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="getWrapperInputStream--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWrapperInputStream</h4>
<pre>public&nbsp;java.util.function.Function&lt;java.io.InputStream,java.io.InputStream&gt;&nbsp;getWrapperInputStream()</pre>
<div class="block">Gets the <code>Function</code> input stream wrapper function.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The input stream wrapper function or null.</dd>
</dl>
</li>
</ul>
<a name="getWrapperOutputStream--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getWrapperOutputStream</h4>
<pre>public&nbsp;java.util.function.Function&lt;java.io.OutputStream,java.io.OutputStream&gt;&nbsp;getWrapperOutputStream()</pre>
<div class="block">Gets the <code>Function</code> output stream wrapper function.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The output stream wrapper function or null.</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/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/marshal/NetMarshalServerWrapped.html" target="_top">Frames</a></li>
<li><a href="NetMarshalServerWrapped.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>

View File

@ -0,0 +1,25 @@
<!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>com.captainalm.lib.calmnet.marshal</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>
<h1 class="bar"><a href="../../../../../com/captainalm/lib/calmnet/marshal/package-summary.html" target="classFrame">com.captainalm.lib.calmnet.marshal</a></h1>
<div class="indexContainer">
<h2 title="Classes">Classes</h2>
<ul title="Classes">
<li><a href="CandidateClient.html" title="class in com.captainalm.lib.calmnet.marshal" target="classFrame">CandidateClient</a></li>
<li><a href="FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal" target="classFrame">FragmentationOptions</a></li>
<li><a href="NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal" target="classFrame">NetMarshalClient</a></li>
<li><a href="NetMarshalClientWrapped.html" title="class in com.captainalm.lib.calmnet.marshal" target="classFrame">NetMarshalClientWrapped</a></li>
<li><a href="NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal" target="classFrame">NetMarshalServer</a></li>
<li><a href="NetMarshalServerWrapped.html" title="class in com.captainalm.lib.calmnet.marshal" target="classFrame">NetMarshalServerWrapped</a></li>
</ul>
</div>
</body>
</html>

View File

@ -0,0 +1,186 @@
<!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>com.captainalm.lib.calmnet.marshal</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="com.captainalm.lib.calmnet.marshal";
}
}
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>Prev&nbsp;Package</li>
<li><a href="../../../../../com/captainalm/lib/calmnet/packet/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/marshal/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.marshal</h1>
<div class="docSummary">
<div class="block">This package contains the network marshals for managed sending of <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>s on sockets.</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/marshal/CandidateClient.html" title="class in com.captainalm.lib.calmnet.marshal">CandidateClient</a></td>
<td class="colLast">
<div class="block">This class provides a candidate client for <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal"><code>NetMarshalServer</code></a>s.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a></td>
<td class="colLast">
<div class="block">This class provides fragmentation options for using <a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentSender</code></a>s and
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentReceiver</code></a>s in this package.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></td>
<td class="colLast">
<div class="block">This class provides a managed way of networking on the client side.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClientWrapped.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClientWrapped</a></td>
<td class="colLast">
<div class="block">This class provides a managed way of networking on the client side, allows stream wrapping.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></td>
<td class="colLast">
<div class="block">This class provides a way of networking on the server side and holds a collection of <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal"><code>NetMarshalClient</code></a>s.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServerWrapped.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServerWrapped</a></td>
<td class="colLast">
<div class="block">This class provides a way of networking on the server side and holds a collection of <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal"><code>NetMarshalClient</code></a>s, allows stream wrapping.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package com.captainalm.lib.calmnet.marshal Description">Package com.captainalm.lib.calmnet.marshal Description</h2>
<div class="block">This package contains the network marshals for managed sending of <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>s on sockets.</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>Prev&nbsp;Package</li>
<li><a href="../../../../../com/captainalm/lib/calmnet/packet/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/marshal/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>

View File

@ -0,0 +1,146 @@
<!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:22 BST 2023 -->
<title>com.captainalm.lib.calmnet.marshal Class Hierarchy</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="com.captainalm.lib.calmnet.marshal Class Hierarchy";
}
}
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><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</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>Prev</li>
<li><a href="../../../../../com/captainalm/lib/calmnet/packet/package-tree.html">Next</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/marshal/package-tree.html" target="_top">Frames</a></li>
<li><a href="package-tree.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 class="title">Hierarchy For Package com.captainalm.lib.calmnet.marshal</h1>
<span class="packageHierarchyLabel">Package Hierarchies:</span>
<ul class="horizontal">
<li><a href="../../../../../overview-tree.html">All Packages</a></li>
</ul>
</div>
<div class="contentContainer">
<h2 title="Class Hierarchy">Class Hierarchy</h2>
<ul>
<li type="circle">java.lang.Object
<ul>
<li type="circle">com.captainalm.lib.calmnet.marshal.<a href="../../../../../com/captainalm/lib/calmnet/marshal/CandidateClient.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">CandidateClient</span></a></li>
<li type="circle">com.captainalm.lib.calmnet.marshal.<a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">FragmentationOptions</span></a></li>
<li type="circle">com.captainalm.lib.calmnet.marshal.<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">NetMarshalClient</span></a> (implements java.io.Closeable)
<ul>
<li type="circle">com.captainalm.lib.calmnet.marshal.<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClientWrapped.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">NetMarshalClientWrapped</span></a></li>
</ul>
</li>
<li type="circle">com.captainalm.lib.calmnet.marshal.<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">NetMarshalServer</span></a> (implements java.io.Closeable)
<ul>
<li type="circle">com.captainalm.lib.calmnet.marshal.<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServerWrapped.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">NetMarshalServerWrapped</span></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</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><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</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>Prev</li>
<li><a href="../../../../../com/captainalm/lib/calmnet/packet/package-tree.html">Next</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/marshal/package-tree.html" target="_top">Frames</a></li>
<li><a href="package-tree.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>

View File

@ -0,0 +1,235 @@
<!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>IAcknowledgement</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="IAcknowledgement";
}
}
catch(err) {
}
//-->
var methods = {"i0":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>Prev&nbsp;Class</li>
<li><a href="../../../../../com/captainalm/lib/calmnet/packet/IInternalCache.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/packet/IAcknowledgement.html" target="_top">Frames</a></li>
<li><a href="IAcknowledgement.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>Constr&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>Constr&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</div>
<h2 title="Interface IAcknowledgement" class="title">Interface IAcknowledgement</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDAKNPacket</a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentRetrySendPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentRetrySendPacket</a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSendCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendCompletePacket</a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionCipherPacket</a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionUpgradePacket</a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkSSLUpgradePacket</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">IAcknowledgement</span></pre>
<div class="block">This interface allows obtaining if the class instance is an Acknowledgement.</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">&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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/IAcknowledgement.html#isAcknowledgement--">isAcknowledgement</a></span>()</code>
<div class="block">Gets if the class instance is an Acknowledgement.</div>
</td>
</tr>
</table>
</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="isAcknowledgement--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isAcknowledgement</h4>
<pre>boolean&nbsp;isAcknowledgement()</pre>
<div class="block">Gets if the class instance is an Acknowledgement.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If the class instance is an Acknowledgement.</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>Prev&nbsp;Class</li>
<li><a href="../../../../../com/captainalm/lib/calmnet/packet/IInternalCache.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/packet/IAcknowledgement.html" target="_top">Frames</a></li>
<li><a href="IAcknowledgement.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>Constr&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>Constr&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>

View File

@ -0,0 +1,256 @@
<!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>IInternalCache</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="IInternalCache";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":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/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/packet/IInternalCache.html" target="_top">Frames</a></li>
<li><a href="IInternalCache.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>Constr&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>Constr&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</div>
<h2 title="Interface IInternalCache" class="title">Interface IInternalCache</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><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">IInternalCache</span></pre>
<div class="block">This interface allows getting and setting if the
internal cache should be used within a class instance.</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">&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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/IInternalCache.html#isCacheUsed--">isCacheUsed</a></span>()</code>
<div class="block">Gets if the internal cache is used.</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/IInternalCache.html#setCacheUsed-boolean-">setCacheUsed</a></span>(boolean&nbsp;used)</code>
<div class="block">Sets if the internal cache is used.</div>
</td>
</tr>
</table>
</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="isCacheUsed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCacheUsed</h4>
<pre>boolean&nbsp;isCacheUsed()</pre>
<div class="block">Gets if the internal cache is used.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If the internal cache is used.</dd>
</dl>
</li>
</ul>
<a name="setCacheUsed-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setCacheUsed</h4>
<pre>void&nbsp;setCacheUsed(boolean&nbsp;used)</pre>
<div class="block">Sets if the internal cache is used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>used</code> - If the internal cache is used.</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/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/packet/IInternalCache.html" target="_top">Frames</a></li>
<li><a href="IInternalCache.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>Constr&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>Constr&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>

View File

@ -0,0 +1,306 @@
<!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>IPacket</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="IPacket";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":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/IInternalCache.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/packet/IPacket.html" target="_top">Frames</a></li>
<li><a href="IPacket.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>Constr&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>Constr&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</div>
<h2 title="Interface IPacket" class="title">Interface IPacket</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</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/fragment/FragmentAllocatePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentAllocatePacket</a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentAllocationPacket</a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentMessagePacket</a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentMessageResponsePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentMessageResponsePacket</a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDAKNPacket</a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDMSGPacket</a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDPacket</a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentRetrySendPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentRetrySendPacket</a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSendCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendCompletePacket</a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSendStopPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendStopPacket</a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSendVerifyCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendVerifyCompletePacket</a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionCipherPacket</a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionUpgradePacket</a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkIdentifierPacket</a>, <a href="../../../../../com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkSSLUpgradePacket</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">IPacket</span></pre>
<div class="block">This interface provides the 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">&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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><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/IPacket.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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#isValid--">isValid</a></span>()</code>
<div class="block">Gets if the packet is valid.</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/IPacket.html#loadPayload-byte:A-">loadPayload</a></span>(byte[]&nbsp;packetData)</code>
<div class="block">Loads the packet payload from save data.</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/IPacket.html#savePayload--">savePayload</a></span>()</code>
<div class="block">Saves the packet payload to a byte array.</div>
</td>
</tr>
</table>
</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="isValid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValid</h4>
<pre>boolean&nbsp;isValid()</pre>
<div class="block">Gets if the packet is valid.</div>
<dl>
<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><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;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="savePayload--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>savePayload</h4>
<pre>byte[]&nbsp;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="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>
<a name="loadPayload-byte:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>loadPayload</h4>
<pre>void&nbsp;loadPayload(byte[]&nbsp;packetData)
throws <a href="../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
<div class="block">Loads the packet payload from save data.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>packetData</code> - The packet payload data.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - The new store data is null.</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>
</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/IInternalCache.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/packet/IPacket.html" target="_top">Frames</a></li>
<li><a href="IPacket.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>Constr&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>Constr&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>

View File

@ -0,0 +1,306 @@
<!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&nbsp;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&nbsp;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&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>Constr&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>Constr&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</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">&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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>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&nbsp;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&nbsp;inputStream,
int&nbsp;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&nbsp;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&nbsp;readData(java.io.OutputStream&nbsp;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&nbsp;writeData(java.io.InputStream&nbsp;inputStream,
int&nbsp;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&nbsp;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&nbsp;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&nbsp;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&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>Constr&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>Constr&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>

View File

@ -0,0 +1,336 @@
<!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>PacketException</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="PacketException";
}
}
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><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/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/packet/PacketException.html" target="_top">Frames</a></li>
<li><a href="PacketException.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="#methods.inherited.from.class.java.lang.Throwable">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>Method</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="Class PacketException" class="title">Class PacketException</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.lang.Throwable</li>
<li>
<ul class="inheritance">
<li>java.lang.Exception</li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.packet.PacketException</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">PacketException</span>
extends java.lang.Exception</pre>
<div class="block">This class provides the packet exception wrapper class.
See <code>Throwable.getCause()</code> to find out the underlying exception.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Captain ALM</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#com.captainalm.lib.calmnet.packet.PacketException">Serialized Form</a></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/PacketException.html#PacketException-java.lang.String-">PacketException</a></span>(java.lang.String&nbsp;message)</code>
<div class="block">Constructs a new exception with the specified detail message.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketException.html#PacketException-java.lang.String-java.lang.Throwable-">PacketException</a></span>(java.lang.String&nbsp;message,
java.lang.Throwable&nbsp;cause)</code>
<div class="block">Constructs a new exception with the specified detail message and
cause.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketException.html#PacketException-java.lang.Throwable-">PacketException</a></span>(java.lang.Throwable&nbsp;cause)</code>
<div class="block">Constructs a new exception with the specified cause and a detail
message of <tt>(cause==null ? null : cause.toString())</tt> (which
typically contains the class and detail message of <tt>cause</tt>).</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Throwable</h3>
<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li>
</ul>
<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, 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="PacketException-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PacketException</h4>
<pre>public&nbsp;PacketException(java.lang.String&nbsp;message)</pre>
<div class="block">Constructs a new exception with the specified detail message. The
cause is not initialized, and may subsequently be initialized by
a call to <code>Throwable.initCause(java.lang.Throwable)</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - the detail message. The detail message is saved for
later retrieval by the <code>Throwable.getMessage()</code> method.</dd>
</dl>
</li>
</ul>
<a name="PacketException-java.lang.String-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PacketException</h4>
<pre>public&nbsp;PacketException(java.lang.String&nbsp;message,
java.lang.Throwable&nbsp;cause)</pre>
<div class="block">Constructs a new exception with the specified detail message and
cause. <p>Note that the detail message associated with
<code>cause</code> is <i>not</i> automatically incorporated in
this exception's detail message.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - the detail message (which is saved for later retrieval
by the <code>Throwable.getMessage()</code> method).</dd>
<dd><code>cause</code> - the cause (which is saved for later retrieval by the
<code>Throwable.getCause()</code> method). (A <tt>null</tt> value is
permitted, and indicates that the cause is nonexistent or
unknown.)</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.4</dd>
</dl>
</li>
</ul>
<a name="PacketException-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PacketException</h4>
<pre>public&nbsp;PacketException(java.lang.Throwable&nbsp;cause)</pre>
<div class="block">Constructs a new exception with the specified cause and a detail
message of <tt>(cause==null ? null : cause.toString())</tt> (which
typically contains the class and detail message of <tt>cause</tt>).
This constructor is useful for exceptions that are little more than
wrappers for other throwables (for example, <code>PrivilegedActionException</code>).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cause</code> - the cause (which is saved for later retrieval by the
<code>Throwable.getCause()</code> method). (A <tt>null</tt> value is
permitted, and indicates that the cause is nonexistent or
unknown.)</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.4</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/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/packet/PacketException.html" target="_top">Frames</a></li>
<li><a href="PacketException.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="#methods.inherited.from.class.java.lang.Throwable">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>Method</li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

View File

@ -0,0 +1,811 @@
<!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>PacketLoader</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="PacketLoader";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9,"i2":10,"i3":9,"i4":10,"i5":9,"i6":9,"i7":9,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":9,"i15":10,"i16":10,"i17":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/PacketException.html" title="class in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/packet/PacketLoader.html" target="_top">Frames</a></li>
<li><a href="PacketLoader.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</div>
<h2 title="Class PacketLoader" class="title">Class PacketLoader</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.packet.PacketLoader</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">PacketLoader</span>
extends java.lang.Object</pre>
<div class="block">This class provides the ability to load and save <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>
to <code>InputStream</code> and <code>OutputStream</code>.
Packets can have contents checking support using <code>DigestProvider</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/PacketLoader.html#PacketLoader--">PacketLoader</a></span>()</code>
<div class="block">Constructs a new Packet loader instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html#PacketLoader-com.captainalm.lib.stdcrypt.digest.DigestProvider-">PacketLoader</a></span>(com.captainalm.lib.stdcrypt.digest.DigestProvider&nbsp;provider)</code>
<div class="block">Constructs a new Packet loader instance with the specified <code>DigestProvider</code>.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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/PacketLoader.html#areInvalidPacketsAllowed--">areInvalidPacketsAllowed</a></span>()</code>
<div class="block">Gets whether invalid packets are allowed to be read and written.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html#getByteArrayFromInteger-int-">getByteArrayFromInteger</a></span>(int&nbsp;i)</code>
<div class="block">Saves an Integer into a byte array.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>com.captainalm.lib.stdcrypt.digest.DigestProvider</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html#getHashProvider--">getHashProvider</a></span>()</code>
<div class="block">This field provides the <code>DigestProvider</code> to use for the payload of the packets on the trailer.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html#getIntegerFromByteArray-byte:A-">getIntegerFromByteArray</a></span>(byte[]&nbsp;bytes)</code>
<div class="block">Loads an Integer from a byte array.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html#getPacketSize-com.captainalm.lib.calmnet.packet.IPacket-boolean-boolean-">getPacketSize</a></span>(<a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packet,
boolean&nbsp;includeInformation,
boolean&nbsp;ignoreDigest)</code>
<div class="block">Gets the total size of a written packet in bytes.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html#readArrayFromInputStream-java.io.InputStream-int-">readArrayFromInputStream</a></span>(java.io.InputStream&nbsp;inputStream,
int&nbsp;length)</code>
<div class="block">Reads in a byte array of a specified length from an <code>InputStream</code>.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static byte</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html#readByteFromInputStream-java.io.InputStream-">readByteFromInputStream</a></span>(java.io.InputStream&nbsp;inputStream)</code>
<div class="block">Reads a byte from an <code>InputStream</code>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html#readInteger-java.io.InputStream-">readInteger</a></span>(java.io.InputStream&nbsp;inputStream)</code>
<div class="block">Reads an Integer from an <code>InputStream</code>.</div>
</td>
</tr>
<tr id="i8" 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/PacketLoader.html#readPacket-java.io.InputStream-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">readPacket</a></span>(java.io.InputStream&nbsp;inputStream,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;information)</code>
<div class="block">Reads a <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> from an input stream.</div>
</td>
</tr>
<tr id="i9" 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/PacketLoader.html#readPacketNoDigest-byte:A-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">readPacketNoDigest</a></span>(byte[]&nbsp;arrayIn,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;information)</code>
<div class="block">Reads a <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> from a byte array (No digest support).</div>
</td>
</tr>
<tr id="i10" 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/PacketLoader.html#readPacketNoDigest-java.io.InputStream-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">readPacketNoDigest</a></span>(java.io.InputStream&nbsp;inputStream,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;information)</code>
<div class="block">Reads a <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> from an input stream (No digest support).</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/PacketLoader.html#readStreamedPacket-java.io.InputStream-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">readStreamedPacket</a></span>(java.io.InputStream&nbsp;inputStream,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;information)</code>
<div class="block">Reads a <a href="../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a> from an input stream.</div>
</td>
</tr>
<tr id="i12" 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/PacketLoader.html#readStreamedPacketNoDigest-java.io.InputStream-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">readStreamedPacketNoDigest</a></span>(java.io.InputStream&nbsp;inputStream,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;information)</code>
<div class="block">Reads a <a href="../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a> from an input stream (No digest support).</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html#setAllowInvalidPackets-boolean-">setAllowInvalidPackets</a></span>(boolean&nbsp;allowInvalidPackets)</code>
<div class="block">This sets whether invalid packets are allowed to be read and written.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html#writeInteger-java.io.OutputStream-int-">writeInteger</a></span>(java.io.OutputStream&nbsp;outputStream,
int&nbsp;i)</code>
<div class="block">Writes an Integer to the <code>OutputStream</code> using 4 bytes.</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/PacketLoader.html#writePacket-java.io.OutputStream-com.captainalm.lib.calmnet.packet.IPacket-boolean-">writePacket</a></span>(java.io.OutputStream&nbsp;outputStream,
<a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packet,
boolean&nbsp;writeInformation)</code>
<div class="block">Writes a <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> to an output stream (No digest support).</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html#writePacketNoDigest-com.captainalm.lib.calmnet.packet.IPacket-boolean-">writePacketNoDigest</a></span>(<a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packet,
boolean&nbsp;writeInformation)</code>
<div class="block">Returns a <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> to a byte array (No digest support).</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/PacketLoader.html#writePacketNoDigest-java.io.OutputStream-com.captainalm.lib.calmnet.packet.IPacket-boolean-">writePacketNoDigest</a></span>(java.io.OutputStream&nbsp;outputStream,
<a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packet,
boolean&nbsp;writeInformation)</code>
<div class="block">Writes a <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> to an output stream.</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="PacketLoader--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PacketLoader</h4>
<pre>public&nbsp;PacketLoader()</pre>
<div class="block">Constructs a new Packet loader instance.
If using a digest provider, use <a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html#PacketLoader-com.captainalm.lib.stdcrypt.digest.DigestProvider-"><code>PacketLoader(DigestProvider)</code></a></div>
</li>
</ul>
<a name="PacketLoader-com.captainalm.lib.stdcrypt.digest.DigestProvider-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PacketLoader</h4>
<pre>public&nbsp;PacketLoader(com.captainalm.lib.stdcrypt.digest.DigestProvider&nbsp;provider)</pre>
<div class="block">Constructs a new Packet loader instance with the specified <code>DigestProvider</code>.
If using a digest provider, make sure all endpoints use the same algorithm;
if null, no trailer is created or expected;
this is ignored if saving / loading packets from byte arrays.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>provider</code> - The digest provider or 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="getHashProvider--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHashProvider</h4>
<pre>public&nbsp;com.captainalm.lib.stdcrypt.digest.DigestProvider&nbsp;getHashProvider()</pre>
<div class="block">This field provides the <code>DigestProvider</code> to use for the payload of the packets on the trailer.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The digest provider in use or null.</dd>
</dl>
</li>
</ul>
<a name="areInvalidPacketsAllowed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>areInvalidPacketsAllowed</h4>
<pre>public&nbsp;boolean&nbsp;areInvalidPacketsAllowed()</pre>
<div class="block">Gets whether invalid packets are allowed to be read and written.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If invalid packets can be processed.</dd>
</dl>
</li>
</ul>
<a name="setAllowInvalidPackets-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAllowInvalidPackets</h4>
<pre>public&nbsp;void&nbsp;setAllowInvalidPackets(boolean&nbsp;allowInvalidPackets)</pre>
<div class="block">This sets whether invalid packets are allowed to be read and written.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>allowInvalidPackets</code> - If invalid packets can be processed.</dd>
</dl>
</li>
</ul>
<a name="readPacketNoDigest-byte:A-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readPacketNoDigest</h4>
<pre>public&nbsp;<a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;readPacketNoDigest(byte[]&nbsp;arrayIn,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;information)
throws <a href="../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
<div class="block">Reads a <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> from a byte array (No digest support).
If the information parameter is null, this is obtained as part of the reading.
NOTE: The <a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html#getHashProvider--"><code>getHashProvider()</code></a> for digests is NOT supported and no digest is expected for these packets.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arrayIn</code> - The byte array for reading.</dd>
<dd><code>factory</code> - 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 to generate packets.</dd>
<dd><code>information</code> - The protocol information or null.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The loaded packet or null.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - The arrayIn or the factory is null.</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="readPacket-java.io.InputStream-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readPacket</h4>
<pre>public&nbsp;<a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;readPacket(java.io.InputStream&nbsp;inputStream,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;information)
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 a <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> from an input stream.
If the information parameter is null, this is obtained as part of the reading.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>inputStream</code> - The input stream for reading.</dd>
<dd><code>factory</code> - 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 to generate packets.</dd>
<dd><code>information</code> - The protocol information or null.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The loaded packet or null.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - The inputStream or the factory is null.</dd>
<dd><code>java.io.IOException</code> - A stream exception occurs.</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="readPacketNoDigest-java.io.InputStream-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readPacketNoDigest</h4>
<pre>public&nbsp;<a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;readPacketNoDigest(java.io.InputStream&nbsp;inputStream,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;information)
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 a <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> from an input stream (No digest support).
If the information parameter is null, this is obtained as part of the reading.
NOTE: The <a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html#getHashProvider--"><code>getHashProvider()</code></a> for digests is NOT supported and no digest is expected for these packets.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>inputStream</code> - The input stream for reading.</dd>
<dd><code>factory</code> - 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 to generate packets.</dd>
<dd><code>information</code> - The protocol information or null.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The loaded packet or null.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - The inputStream or the factory is null.</dd>
<dd><code>java.io.IOException</code> - A stream exception occurs.</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="readStreamedPacket-java.io.InputStream-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readStreamedPacket</h4>
<pre>public&nbsp;<a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;readStreamedPacket(java.io.InputStream&nbsp;inputStream,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;information)
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 a <a href="../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a> from an input stream.
If the information parameter is null, this is obtained as part of the reading.
NOTE: The packet may be an <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> if no stream packet is available for that protocol.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>inputStream</code> - The input stream for reading.</dd>
<dd><code>factory</code> - 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 to generate packets.</dd>
<dd><code>information</code> - The protocol information or null.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The loaded packet or null.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - The inputStream or the factory is null.</dd>
<dd><code>java.io.IOException</code> - A stream exception occurs.</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="readStreamedPacketNoDigest-java.io.InputStream-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readStreamedPacketNoDigest</h4>
<pre>public&nbsp;<a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;readStreamedPacketNoDigest(java.io.InputStream&nbsp;inputStream,
<a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;information)
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 a <a href="../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a> from an input stream (No digest support).
If the information parameter is null, this is obtained as part of the reading.
NOTE: The packet may be an <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> if no stream packet is available for that protocol.
NOTE: The <a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html#getHashProvider--"><code>getHashProvider()</code></a> for digests is NOT supported and no digest is expected for these packets.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>inputStream</code> - The input stream for reading.</dd>
<dd><code>factory</code> - 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 to generate packets.</dd>
<dd><code>information</code> - The protocol information or null.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The loaded packet or null.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - The inputStream or the factory is null.</dd>
<dd><code>java.io.IOException</code> - A stream exception occurs.</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="writePacketNoDigest-com.captainalm.lib.calmnet.packet.IPacket-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writePacketNoDigest</h4>
<pre>public&nbsp;byte[]&nbsp;writePacketNoDigest(<a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packet,
boolean&nbsp;writeInformation)
throws <a href="../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
<div class="block">Returns a <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> to a byte array (No digest support).
NOTE: The <a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html#getHashProvider--"><code>getHashProvider()</code></a> for digests is NOT supported and no digest is expected for these packets.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>packet</code> - The packet to save.</dd>
<dd><code>writeInformation</code> - Write the <a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketProtocolInformation</code></a> to the beginning of the array.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - A parameter is null.</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="writePacket-java.io.OutputStream-com.captainalm.lib.calmnet.packet.IPacket-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writePacket</h4>
<pre>public&nbsp;void&nbsp;writePacket(java.io.OutputStream&nbsp;outputStream,
<a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packet,
boolean&nbsp;writeInformation)
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 a <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> to an output stream (No digest support).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>outputStream</code> - The output stream for writing.</dd>
<dd><code>packet</code> - The packet to save.</dd>
<dd><code>writeInformation</code> - Write the <a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketProtocolInformation</code></a> to the stream.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - A parameter is null.</dd>
<dd><code>java.io.IOException</code> - A stream exception occurs.</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="writePacketNoDigest-java.io.OutputStream-com.captainalm.lib.calmnet.packet.IPacket-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writePacketNoDigest</h4>
<pre>public&nbsp;void&nbsp;writePacketNoDigest(java.io.OutputStream&nbsp;outputStream,
<a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packet,
boolean&nbsp;writeInformation)
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 a <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> to an output stream.
NOTE: The <a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html#getHashProvider--"><code>getHashProvider()</code></a> for digests is NOT supported and no digest is expected for these packets.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>outputStream</code> - The output stream for writing.</dd>
<dd><code>packet</code> - The packet to save.</dd>
<dd><code>writeInformation</code> - Write the <a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketProtocolInformation</code></a> to the stream.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - A parameter is null.</dd>
<dd><code>java.io.IOException</code> - A stream exception occurs.</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="readInteger-java.io.InputStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readInteger</h4>
<pre>public static&nbsp;int&nbsp;readInteger(java.io.InputStream&nbsp;inputStream)
throws java.io.IOException</pre>
<div class="block">Reads an Integer from an <code>InputStream</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>inputStream</code> - The input stream to use.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The integer that was stored.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - inputStream is null.</dd>
<dd><code>java.io.IOException</code> - An I/O error has occurred.</dd>
</dl>
</li>
</ul>
<a name="writeInteger-java.io.OutputStream-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeInteger</h4>
<pre>public static&nbsp;void&nbsp;writeInteger(java.io.OutputStream&nbsp;outputStream,
int&nbsp;i)
throws java.io.IOException</pre>
<div class="block">Writes an Integer to the <code>OutputStream</code> using 4 bytes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>outputStream</code> - The output stream to use.</dd>
<dd><code>i</code> - The integer to store.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - outputStream is null.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - i is less than 0.</dd>
<dd><code>java.io.IOException</code> - An I/O error has occurred.</dd>
</dl>
</li>
</ul>
<a name="readByteFromInputStream-java.io.InputStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readByteFromInputStream</h4>
<pre>public static&nbsp;byte&nbsp;readByteFromInputStream(java.io.InputStream&nbsp;inputStream)
throws java.io.IOException</pre>
<div class="block">Reads a byte from an <code>InputStream</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>inputStream</code> - The input stream to read from.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The byte read.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - inputStream is null.</dd>
<dd><code>java.io.IOException</code> - An I/O error has occurred or end of stream has been reached.</dd>
</dl>
</li>
</ul>
<a name="readArrayFromInputStream-java.io.InputStream-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readArrayFromInputStream</h4>
<pre>public static&nbsp;byte[]&nbsp;readArrayFromInputStream(java.io.InputStream&nbsp;inputStream,
int&nbsp;length)
throws java.io.IOException</pre>
<div class="block">Reads in a byte array of a specified length from an <code>InputStream</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>inputStream</code> - The input stream to read from.</dd>
<dd><code>length</code> - The length of the stream.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The array of read 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> - length is less than 0.</dd>
<dd><code>java.io.IOException</code> - An I/O error occurs or end of stream has been reached.</dd>
</dl>
</li>
</ul>
<a name="getByteArrayFromInteger-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getByteArrayFromInteger</h4>
<pre>public static&nbsp;byte[]&nbsp;getByteArrayFromInteger(int&nbsp;i)</pre>
<div class="block">Saves an Integer into a byte array.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>i</code> - The integer to save.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The byte array.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - i is less than 0.</dd>
</dl>
</li>
</ul>
<a name="getIntegerFromByteArray-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIntegerFromByteArray</h4>
<pre>public static&nbsp;int&nbsp;getIntegerFromByteArray(byte[]&nbsp;bytes)</pre>
<div class="block">Loads an Integer from a byte array.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bytes</code> - The byte array.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The integer.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - bytes is null.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - bytes length is not 4.</dd>
</dl>
</li>
</ul>
<a name="getPacketSize-com.captainalm.lib.calmnet.packet.IPacket-boolean-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPacketSize</h4>
<pre>public&nbsp;int&nbsp;getPacketSize(<a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packet,
boolean&nbsp;includeInformation,
boolean&nbsp;ignoreDigest)
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 total size of a written packet in bytes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>packet</code> - The packet to check.</dd>
<dd><code>includeInformation</code> - If the 2 byte information header is included.</dd>
<dd><code>ignoreDigest</code> - If the digest length should be ignored if available.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The size of the packet in bytes.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - packet is null.</dd>
<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>
</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/PacketException.html" title="class in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/packet/PacketLoader.html" target="_top">Frames</a></li>
<li><a href="PacketLoader.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>

View File

@ -0,0 +1,426 @@
<!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>PacketProtocolInformation</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="PacketProtocolInformation";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":10,"i5":9};
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/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" target="_top">Frames</a></li>
<li><a href="PacketProtocolInformation.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</div>
<h2 title="Class PacketProtocolInformation" class="title">Class PacketProtocolInformation</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.packet.PacketProtocolInformation</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">PacketProtocolInformation</span>
extends java.lang.Object</pre>
<div class="block">This class provides the packet protocol information for <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>.</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/PacketProtocolInformation.html#PacketProtocolInformation--">PacketProtocolInformation</a></span>()</code>
<div class="block">Constructs a new instance of PacketProtocolInformation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html#PacketProtocolInformation-byte-byte-">PacketProtocolInformation</a></span>(byte&nbsp;major,
byte&nbsp;minor)</code>
<div class="block">Constructs a new instance of PacketProtocolInformation.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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/PacketProtocolInformation.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;o)</code>
<div class="block">Gets whether this object equals the passed object.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html#getMajor--">getMajor</a></span>()</code>
<div class="block">Gets the major protocol for the packet.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html#getMinor--">getMinor</a></span>()</code>
<div class="block">Gets the minor protocol for the packet.</div>
</td>
</tr>
<tr id="i3" 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/PacketProtocolInformation.html#getProtocolInformation-java.io.InputStream-">getProtocolInformation</a></span>(java.io.InputStream&nbsp;inputStream)</code>
<div class="block">Gets the <a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketProtocolInformation</code></a> of the packet.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html#hashCode--">hashCode</a></span>()</code>
<div class="block">Gets the hash code of the object.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html#savePacketProtocolInformation-java.io.OutputStream-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">savePacketProtocolInformation</a></span>(java.io.OutputStream&nbsp;outputStream,
<a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;information)</code>
<div class="block">Saves the <a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketProtocolInformation</code></a> of the packet.</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>getClass, 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="PacketProtocolInformation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PacketProtocolInformation</h4>
<pre>public&nbsp;PacketProtocolInformation()</pre>
<div class="block">Constructs a new instance of PacketProtocolInformation.
This is set to 0 Major, 0 Minor.</div>
</li>
</ul>
<a name="PacketProtocolInformation-byte-byte-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PacketProtocolInformation</h4>
<pre>public&nbsp;PacketProtocolInformation(byte&nbsp;major,
byte&nbsp;minor)</pre>
<div class="block">Constructs a new instance of PacketProtocolInformation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>major</code> - The major version.</dd>
<dd><code>minor</code> - The minor version.</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="getMajor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMajor</h4>
<pre>public&nbsp;int&nbsp;getMajor()</pre>
<div class="block">Gets the major protocol for the packet.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The major protocol.</dd>
</dl>
</li>
</ul>
<a name="getMinor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMinor</h4>
<pre>public&nbsp;int&nbsp;getMinor()</pre>
<div class="block">Gets the minor protocol for the packet.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The minor protocol.</dd>
</dl>
</li>
</ul>
<a name="getProtocolInformation-java.io.InputStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProtocolInformation</h4>
<pre>public static&nbsp;<a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;getProtocolInformation(java.io.InputStream&nbsp;inputStream)
throws java.io.IOException</pre>
<div class="block">Gets the <a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketProtocolInformation</code></a> of the packet.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>inputStream</code> - The input stream for reading.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The protocol information.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - The inputStream is null.</dd>
<dd><code>java.io.IOException</code> - A stream exception occurs.</dd>
</dl>
</li>
</ul>
<a name="savePacketProtocolInformation-java.io.OutputStream-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>savePacketProtocolInformation</h4>
<pre>public static&nbsp;void&nbsp;savePacketProtocolInformation(java.io.OutputStream&nbsp;outputStream,
<a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;information)
throws java.io.IOException</pre>
<div class="block">Saves the <a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketProtocolInformation</code></a> of the packet.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>outputStream</code> - The output stream for writing.</dd>
<dd><code>information</code> - The protocol information.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - A parameter is null.</dd>
<dd><code>java.io.IOException</code> - A stream exception occurs.</dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;o)</pre>
<div class="block">Gets whether this object equals the passed object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>o</code> - The object to check.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If the objects are equivalent.</dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<div class="block">Gets the hash code of the object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The hash code of the object.</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/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" target="_top">Frames</a></li>
<li><a href="PacketProtocolInformation.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>

View File

@ -0,0 +1,736 @@
<!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>Base64Packet</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="Base64Packet";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":9,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":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>Prev&nbsp;Class</li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/core/Base64Packet.html" target="_top">Frames</a></li>
<li><a href="Base64Packet.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.core</div>
<h2 title="Class Base64Packet" class="title">Class Base64Packet</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.packet.core.Base64Packet</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>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">Base64Packet</span>
extends java.lang.Object
implements <a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</a></pre>
<div class="block">This class provides a base64 encrypted packet that can hold an <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>.
<p>
Major ID: 255
Minor ID: 251
</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">&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/core/Base64Packet.html#Base64Packet-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-">Base64Packet</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,
<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">Constructs a new Base64Packet with the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a> and <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#Base64Packet-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-boolean-">Base64Packet</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,
<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a>&nbsp;loader,
boolean&nbsp;useCache)</code>
<div class="block">Constructs a new Base64Packet with the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>
and if the encrypted data should be cached.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#Base64Packet-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.packet.IPacket-">Base64Packet</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,
<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/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packet)</code>
<div class="block">Constructs a new Base64Packet with the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <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/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#Base64Packet-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.packet.IPacket-boolean-">Base64Packet</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,
<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/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packet,
boolean&nbsp;useCache)</code>
<div class="block">Constructs a new Base64Packet with the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>,
<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> and if the encrypted data should be cached.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><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/core/Base64Packet.html#getFactory--">getFactory</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="i1" 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/core/Base64Packet.html#getHeldPacket--">getHeldPacket</a></span>()</code>
<div class="block">Gets the held packet or null.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<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/core/Base64Packet.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="i3" class="rowColor">
<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/core/Base64Packet.html#getProtocol--">getProtocol</a></span>()</code>
<div class="block">Gets the protocol information.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#getSize--">getSize</a></span>()</code>
<div class="block">Gets the size of the output data.</div>
</td>
</tr>
<tr id="i5" 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/core/Base64Packet.html#getTheProtocol--">getTheProtocol</a></span>()</code>
<div class="block">Gets the protocol information statically.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#isCacheUsed--">isCacheUsed</a></span>()</code>
<div class="block">Gets if the encrypted data is cached.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#isValid--">isValid</a></span>()</code>
<div class="block">Gets if the packet is valid.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#loadPayload-byte:A-">loadPayload</a></span>(byte[]&nbsp;packetData)</code>
<div class="block">Loads the packet payload from save data.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#readData-java.io.OutputStream-">readData</a></span>(java.io.OutputStream&nbsp;outputStream)</code>
<div class="block">Reads payload data to an <code>OutputStream</code>.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#savePayload--">savePayload</a></span>()</code>
<div class="block">Saves the packet payload to a byte array.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#setCacheUsed-boolean-">setCacheUsed</a></span>(boolean&nbsp;used)</code>
<div class="block">Sets if the encrypted data is cached.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#setFactory-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-">setFactory</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="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#setHeldPacket-com.captainalm.lib.calmnet.packet.IPacket-">setHeldPacket</a></span>(<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packet)</code>
<div class="block">Sets the held packet.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.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="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#writeData-java.io.InputStream-int-">writeData</a></span>(java.io.InputStream&nbsp;inputStream,
int&nbsp;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.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="Base64Packet-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Base64Packet</h4>
<pre>public&nbsp;Base64Packet(<a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<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">Constructs a new Base64Packet with the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a> and <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>.
The encrypted data will not be cached.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - The packet factory to use.</dd>
<dd><code>loader</code> - The Packet Loader to use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - factory or loader is null.</dd>
</dl>
</li>
</ul>
<a name="Base64Packet-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Base64Packet</h4>
<pre>public&nbsp;Base64Packet(<a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a>&nbsp;loader,
boolean&nbsp;useCache)</pre>
<div class="block">Constructs a new Base64Packet with the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>
and if the encrypted data should be cached.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - The packet factory to use.</dd>
<dd><code>loader</code> - The Packet Loader to use.</dd>
<dd><code>useCache</code> - If the encrypted data should be cached.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - factory or loader is null.</dd>
</dl>
</li>
</ul>
<a name="Base64Packet-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.packet.IPacket-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Base64Packet</h4>
<pre>public&nbsp;Base64Packet(<a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<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/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packet)</pre>
<div class="block">Constructs a new Base64Packet with the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <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/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>.
The encrypted data will not be cached.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - The packet factory to use.</dd>
<dd><code>loader</code> - The Packet Loader to use.</dd>
<dd><code>packet</code> - The packet to store or null.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - factory or loader is null.</dd>
</dl>
</li>
</ul>
<a name="Base64Packet-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.packet.IPacket-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Base64Packet</h4>
<pre>public&nbsp;Base64Packet(<a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<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/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packet,
boolean&nbsp;useCache)</pre>
<div class="block">Constructs a new Base64Packet with the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>,
<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> and if the encrypted data should be cached.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - The packet factory to use.</dd>
<dd><code>loader</code> - The Packet Loader to use.</dd>
<dd><code>packet</code> - The packet to store or null.</dd>
<dd><code>useCache</code> - If the encrypted data should be cached.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - factory or loader 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="isValid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValid</h4>
<pre>public&nbsp;boolean&nbsp;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>&nbsp;in interface&nbsp;<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="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&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;getProtocol()</pre>
<div class="block">Gets the protocol information.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#getProtocol--">getProtocol</a></code>&nbsp;in interface&nbsp;<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="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&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;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="blockList">
<li class="blockList">
<h4>savePayload</h4>
<pre>public&nbsp;byte[]&nbsp;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>&nbsp;in interface&nbsp;<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="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>
<a name="loadPayload-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadPayload</h4>
<pre>public&nbsp;void&nbsp;loadPayload(byte[]&nbsp;packetData)
throws <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
<div class="block">Loads the packet payload from save data.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#loadPayload-byte:A-">loadPayload</a></code>&nbsp;in interface&nbsp;<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="paramLabel">Parameters:</span></dt>
<dd><code>packetData</code> - The packet payload data.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - The new store data is null.</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="readData-java.io.OutputStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readData</h4>
<pre>public&nbsp;void&nbsp;readData(java.io.OutputStream&nbsp;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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html#readData-java.io.OutputStream-">readData</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</a></code></dd>
<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>public&nbsp;void&nbsp;writeData(java.io.InputStream&nbsp;inputStream,
int&nbsp;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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html#writeData-java.io.InputStream-int-">writeData</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</a></code></dd>
<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="blockList">
<li class="blockList">
<h4>getSize</h4>
<pre>public&nbsp;int&nbsp;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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html#getSize--">getSize</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</a></code></dd>
<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>
<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 Packet Loader 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="getFactory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFactory</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;getFactory()</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 Packet Factory in use.</dd>
</dl>
</li>
</ul>
<a name="setFactory-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFactory</h4>
<pre>public&nbsp;void&nbsp;setFactory(<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="getHeldPacket--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeldPacket</h4>
<pre>public&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;getHeldPacket()</pre>
<div class="block">Gets the held packet or null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The packet or null.</dd>
</dl>
</li>
</ul>
<a name="setHeldPacket-com.captainalm.lib.calmnet.packet.IPacket-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHeldPacket</h4>
<pre>public&nbsp;void&nbsp;setHeldPacket(<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packet)</pre>
<div class="block">Sets the held packet.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>packet</code> - The new packet or null.</dd>
</dl>
</li>
</ul>
<a name="isCacheUsed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCacheUsed</h4>
<pre>public&nbsp;boolean&nbsp;isCacheUsed()</pre>
<div class="block">Gets if the encrypted data is cached.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If the encrypted data is cached.</dd>
</dl>
</li>
</ul>
<a name="setCacheUsed-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setCacheUsed</h4>
<pre>public&nbsp;void&nbsp;setCacheUsed(boolean&nbsp;used)</pre>
<div class="block">Sets if the encrypted data is cached.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>used</code> - If the encrypted data should be cached.</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>Prev&nbsp;Class</li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/core/Base64Packet.html" target="_top">Frames</a></li>
<li><a href="Base64Packet.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>

View File

@ -0,0 +1,832 @@
<!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>EncryptedPacket</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="EncryptedPacket";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":9,"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};
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/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" target="_top">Frames</a></li>
<li><a href="EncryptedPacket.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.core</div>
<h2 title="Class EncryptedPacket" class="title">Class EncryptedPacket</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.packet.core.EncryptedPacket</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/IInternalCache.html" title="interface in com.captainalm.lib.calmnet.packet">IInternalCache</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">EncryptedPacket</span>
extends java.lang.Object
implements <a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/IInternalCache.html" title="interface in com.captainalm.lib.calmnet.packet">IInternalCache</a></pre>
<div class="block">This class provides an encrypted packet that can hold an <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>.
<p>
Major ID: 255
Minor ID: 252
</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">&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/core/EncryptedPacket.html#EncryptedPacket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.stdcrypt.encryption.ICipherFactory-">EncryptedPacket</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,
<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a>&nbsp;loader,
com.captainalm.lib.stdcrypt.encryption.ICipherFactory&nbsp;cipherFactory)</code>
<div class="block">Constructs a new EncryptedPacket with the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a> and <code>ICipherFactory</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#EncryptedPacket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.stdcrypt.encryption.ICipherFactory-boolean-">EncryptedPacket</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,
<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a>&nbsp;loader,
com.captainalm.lib.stdcrypt.encryption.ICipherFactory&nbsp;cipherFactory,
boolean&nbsp;useCache)</code>
<div class="block">Constructs a new EncryptedPacket with the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <code>ICipherFactory</code>
and if the encrypted data should be cached.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#EncryptedPacket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.stdcrypt.encryption.ICipherFactory-com.captainalm.lib.calmnet.packet.IPacket-">EncryptedPacket</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,
<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a>&nbsp;loader,
com.captainalm.lib.stdcrypt.encryption.ICipherFactory&nbsp;cipherFactory,
<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packet)</code>
<div class="block">Constructs a new EncryptedPacket with the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <code>ICipherFactory</code> and <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#EncryptedPacket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.stdcrypt.encryption.ICipherFactory-com.captainalm.lib.calmnet.packet.IPacket-boolean-">EncryptedPacket</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,
<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a>&nbsp;loader,
com.captainalm.lib.stdcrypt.encryption.ICipherFactory&nbsp;cipherFactory,
<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packet,
boolean&nbsp;useCache)</code>
<div class="block">Constructs a new EncryptedPacket with the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <code>ICipherFactory</code>,
<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> and if the encrypted data should be cached.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>com.captainalm.lib.stdcrypt.encryption.ICipherFactory</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#getCipherFactory--">getCipherFactory</a></span>()</code>
<div class="block">Gets the <code>ICipherFactory</code> being used.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<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/core/EncryptedPacket.html#getFactory--">getFactory</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="i2" 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/core/EncryptedPacket.html#getHeldPacket--">getHeldPacket</a></span>()</code>
<div class="block">Gets the held packet or null.</div>
</td>
</tr>
<tr id="i3" 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/core/EncryptedPacket.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="i4" 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/core/EncryptedPacket.html#getProtocol--">getProtocol</a></span>()</code>
<div class="block">Gets the protocol information.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#getSize--">getSize</a></span>()</code>
<div class="block">Gets the size of the output data.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<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/core/EncryptedPacket.html#getTheProtocol--">getTheProtocol</a></span>()</code>
<div class="block">Gets the protocol information statically.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#getTrailingPassword--">getTrailingPassword</a></span>()</code>
<div class="block">Gets the trailing password (Or null if no trailing password).</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#isCacheUsed--">isCacheUsed</a></span>()</code>
<div class="block">Gets if the encrypted data is cached.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#isValid--">isValid</a></span>()</code>
<div class="block">Gets if the packet is valid.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#loadPayload-byte:A-">loadPayload</a></span>(byte[]&nbsp;packetData)</code>
<div class="block">Loads the packet payload from save data.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#readData-java.io.OutputStream-">readData</a></span>(java.io.OutputStream&nbsp;outputStream)</code>
<div class="block">Reads payload data to an <code>OutputStream</code>.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#savePayload--">savePayload</a></span>()</code>
<div class="block">Saves the packet payload to a byte array.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#setCacheUsed-boolean-">setCacheUsed</a></span>(boolean&nbsp;used)</code>
<div class="block">Sets if the encrypted data is cached.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#setCipherFactory-com.captainalm.lib.stdcrypt.encryption.ICipherFactory-">setCipherFactory</a></span>(com.captainalm.lib.stdcrypt.encryption.ICipherFactory&nbsp;cipherFactory)</code>
<div class="block">Sets the <code>ICipherFactory</code> being used.</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/core/EncryptedPacket.html#setFactory-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-">setFactory</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="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#setHeldPacket-com.captainalm.lib.calmnet.packet.IPacket-">setHeldPacket</a></span>(<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packet)</code>
<div class="block">Sets the held packet.</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/core/EncryptedPacket.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/core/EncryptedPacket.html#setTrailingPassword-java.lang.String-">setTrailingPassword</a></span>(java.lang.String&nbsp;trailingPassword)</code>
<div class="block">Sets the trailing password (Use null for no trailing password).</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/core/EncryptedPacket.html#writeData-java.io.InputStream-int-">writeData</a></span>(java.io.InputStream&nbsp;inputStream,
int&nbsp;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.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="EncryptedPacket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.stdcrypt.encryption.ICipherFactory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EncryptedPacket</h4>
<pre>public&nbsp;EncryptedPacket(<a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a>&nbsp;loader,
com.captainalm.lib.stdcrypt.encryption.ICipherFactory&nbsp;cipherFactory)</pre>
<div class="block">Constructs a new EncryptedPacket with the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a> and <code>ICipherFactory</code>.
The encrypted data will not be cached.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - The packet factory to use.</dd>
<dd><code>loader</code> - The Packet Loader to use.</dd>
<dd><code>cipherFactory</code> - The cipher factory to use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - factory, loader or cipherFactory is null.</dd>
</dl>
</li>
</ul>
<a name="EncryptedPacket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.stdcrypt.encryption.ICipherFactory-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EncryptedPacket</h4>
<pre>public&nbsp;EncryptedPacket(<a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a>&nbsp;loader,
com.captainalm.lib.stdcrypt.encryption.ICipherFactory&nbsp;cipherFactory,
boolean&nbsp;useCache)</pre>
<div class="block">Constructs a new EncryptedPacket with the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <code>ICipherFactory</code>
and if the encrypted data should be cached.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - The packet factory to use.</dd>
<dd><code>loader</code> - The Packet Loader to use.</dd>
<dd><code>cipherFactory</code> - The cipher factory to use.</dd>
<dd><code>useCache</code> - If the encrypted data should be cached.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - factory, loader or cipherFactory is null.</dd>
</dl>
</li>
</ul>
<a name="EncryptedPacket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.stdcrypt.encryption.ICipherFactory-com.captainalm.lib.calmnet.packet.IPacket-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EncryptedPacket</h4>
<pre>public&nbsp;EncryptedPacket(<a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a>&nbsp;loader,
com.captainalm.lib.stdcrypt.encryption.ICipherFactory&nbsp;cipherFactory,
<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packet)</pre>
<div class="block">Constructs a new EncryptedPacket with the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <code>ICipherFactory</code> and <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>.
The encrypted data will not be cached.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - The packet factory to use.</dd>
<dd><code>loader</code> - The Packet Loader to use.</dd>
<dd><code>cipherFactory</code> - The cipher factory to use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - factory, loader or cipherFactory is null.</dd>
</dl>
</li>
</ul>
<a name="EncryptedPacket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.stdcrypt.encryption.ICipherFactory-com.captainalm.lib.calmnet.packet.IPacket-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>EncryptedPacket</h4>
<pre>public&nbsp;EncryptedPacket(<a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>&nbsp;factory,
<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a>&nbsp;loader,
com.captainalm.lib.stdcrypt.encryption.ICipherFactory&nbsp;cipherFactory,
<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packet,
boolean&nbsp;useCache)</pre>
<div class="block">Constructs a new EncryptedPacket with the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <code>ICipherFactory</code>,
<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> and if the encrypted data should be cached.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - The packet factory to use.</dd>
<dd><code>loader</code> - The Packet Loader to use.</dd>
<dd><code>cipherFactory</code> - The cipher factory to use.</dd>
<dd><code>useCache</code> - If the encrypted data should be cached.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - factory, loader or cipherFactory 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="isValid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValid</h4>
<pre>public&nbsp;boolean&nbsp;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>&nbsp;in interface&nbsp;<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="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&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;getProtocol()</pre>
<div class="block">Gets the protocol information.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#getProtocol--">getProtocol</a></code>&nbsp;in interface&nbsp;<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="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&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;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="blockList">
<li class="blockList">
<h4>savePayload</h4>
<pre>public&nbsp;byte[]&nbsp;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>&nbsp;in interface&nbsp;<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="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>
<a name="loadPayload-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadPayload</h4>
<pre>public&nbsp;void&nbsp;loadPayload(byte[]&nbsp;packetData)
throws <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
<div class="block">Loads the packet payload from save data.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#loadPayload-byte:A-">loadPayload</a></code>&nbsp;in interface&nbsp;<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="paramLabel">Parameters:</span></dt>
<dd><code>packetData</code> - The packet payload data.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - The new store data is null.</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="readData-java.io.OutputStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readData</h4>
<pre>public&nbsp;void&nbsp;readData(java.io.OutputStream&nbsp;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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html#readData-java.io.OutputStream-">readData</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</a></code></dd>
<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>public&nbsp;void&nbsp;writeData(java.io.InputStream&nbsp;inputStream,
int&nbsp;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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html#writeData-java.io.InputStream-int-">writeData</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</a></code></dd>
<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="blockList">
<li class="blockList">
<h4>getSize</h4>
<pre>public&nbsp;int&nbsp;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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html#getSize--">getSize</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</a></code></dd>
<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>
<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 Packet Loader 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="getFactory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFactory</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;getFactory()</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 Packet Factory in use.</dd>
</dl>
</li>
</ul>
<a name="setFactory-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFactory</h4>
<pre>public&nbsp;void&nbsp;setFactory(<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="getCipherFactory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCipherFactory</h4>
<pre>public&nbsp;com.captainalm.lib.stdcrypt.encryption.ICipherFactory&nbsp;getCipherFactory()</pre>
<div class="block">Gets the <code>ICipherFactory</code> being used.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The Cipher Factory.</dd>
</dl>
</li>
</ul>
<a name="setCipherFactory-com.captainalm.lib.stdcrypt.encryption.ICipherFactory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCipherFactory</h4>
<pre>public&nbsp;void&nbsp;setCipherFactory(com.captainalm.lib.stdcrypt.encryption.ICipherFactory&nbsp;cipherFactory)</pre>
<div class="block">Sets the <code>ICipherFactory</code> being used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cipherFactory</code> - The Cipher Factory.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - cipherFactory is null.</dd>
</dl>
</li>
</ul>
<a name="getTrailingPassword--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTrailingPassword</h4>
<pre>public&nbsp;java.lang.String&nbsp;getTrailingPassword()</pre>
<div class="block">Gets the trailing password (Or null if no trailing password).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The trailing password or null.</dd>
</dl>
</li>
</ul>
<a name="setTrailingPassword-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTrailingPassword</h4>
<pre>public&nbsp;void&nbsp;setTrailingPassword(java.lang.String&nbsp;trailingPassword)</pre>
<div class="block">Sets the trailing password (Use null for no trailing password).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>trailingPassword</code> - The new trailing password or null.</dd>
</dl>
</li>
</ul>
<a name="getHeldPacket--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeldPacket</h4>
<pre>public&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;getHeldPacket()</pre>
<div class="block">Gets the held packet or null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The packet or null.</dd>
</dl>
</li>
</ul>
<a name="setHeldPacket-com.captainalm.lib.calmnet.packet.IPacket-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHeldPacket</h4>
<pre>public&nbsp;void&nbsp;setHeldPacket(<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packet)</pre>
<div class="block">Sets the held packet.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>packet</code> - The new packet or null.</dd>
</dl>
</li>
</ul>
<a name="isCacheUsed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCacheUsed</h4>
<pre>public&nbsp;boolean&nbsp;isCacheUsed()</pre>
<div class="block">Gets if the encrypted data is cached.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IInternalCache.html#isCacheUsed--">isCacheUsed</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IInternalCache.html" title="interface in com.captainalm.lib.calmnet.packet">IInternalCache</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If the encrypted data is cached.</dd>
</dl>
</li>
</ul>
<a name="setCacheUsed-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setCacheUsed</h4>
<pre>public&nbsp;void&nbsp;setCacheUsed(boolean&nbsp;used)</pre>
<div class="block">Sets if the encrypted data is cached.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IInternalCache.html#setCacheUsed-boolean-">setCacheUsed</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IInternalCache.html" title="interface in com.captainalm.lib.calmnet.packet">IInternalCache</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>used</code> - If the encrypted data should be cached.</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/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" target="_top">Frames</a></li>
<li><a href="EncryptedPacket.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>

View File

@ -0,0 +1,590 @@
<!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>NetworkEncryptionCipherPacket</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="NetworkEncryptionCipherPacket";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":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/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" target="_top">Frames</a></li>
<li><a href="NetworkEncryptionCipherPacket.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.core</div>
<h2 title="Class NetworkEncryptionCipherPacket" class="title">Class NetworkEncryptionCipherPacket</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.packet.core.NetworkEncryptionCipherPacket</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/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/IInternalCache.html" title="interface in com.captainalm.lib.calmnet.packet">IInternalCache</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">NetworkEncryptionCipherPacket</span>
extends java.lang.Object
implements <a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/IInternalCache.html" title="interface in com.captainalm.lib.calmnet.packet">IInternalCache</a></pre>
<div class="block">This class provides the ability for supporting streams to negotiate a cipher.
<p>
Major ID: 255
Minor ID: 250
</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">&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/core/NetworkEncryptionCipherPacket.html#NetworkEncryptionCipherPacket-java.lang.Boolean-java.lang.String:A-">NetworkEncryptionCipherPacket</a></span>(java.lang.Boolean&nbsp;acknowledgement,
java.lang.String[]&nbsp;cipherNames)</code>
<div class="block">Constructs a new instance of NetworkEncryptionCipherPacket with the specified acknowledgement value and the specified ciphers.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html#getCiphers--">getCiphers</a></span>()</code>
<div class="block">Gets the cipher names this packet contains.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<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/core/NetworkEncryptionCipherPacket.html#getProtocol--">getProtocol</a></span>()</code>
<div class="block">Gets the protocol information.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html#getSize--">getSize</a></span>()</code>
<div class="block">Gets the size of the output data.</div>
</td>
</tr>
<tr id="i3" 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/core/NetworkEncryptionCipherPacket.html#getTheProtocol--">getTheProtocol</a></span>()</code>
<div class="block">Gets the protocol information statically.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html#isAcknowledgement--">isAcknowledgement</a></span>()</code>
<div class="block">Gets if the class instance is an Acknowledgement.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html#isCacheUsed--">isCacheUsed</a></span>()</code>
<div class="block">Gets if the cipher information is cached.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html#isValid--">isValid</a></span>()</code>
<div class="block">Gets if the packet is valid.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html#loadPayload-byte:A-">loadPayload</a></span>(byte[]&nbsp;packetData)</code>
<div class="block">Loads the packet payload from save data.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html#readData-java.io.OutputStream-">readData</a></span>(java.io.OutputStream&nbsp;outputStream)</code>
<div class="block">Reads payload data to an <code>OutputStream</code>.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html#savePayload--">savePayload</a></span>()</code>
<div class="block">Saves the packet payload to a byte array.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html#setCacheUsed-boolean-">setCacheUsed</a></span>(boolean&nbsp;used)</code>
<div class="block">Sets if the cipher information is cached.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html#setCiphers-java.lang.String:A-">setCiphers</a></span>(java.lang.String[]&nbsp;cipherNames)</code>
<div class="block">Sets the cipher names this packet contains.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html#writeData-java.io.InputStream-int-">writeData</a></span>(java.io.InputStream&nbsp;inputStream,
int&nbsp;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.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="NetworkEncryptionCipherPacket-java.lang.Boolean-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NetworkEncryptionCipherPacket</h4>
<pre>public&nbsp;NetworkEncryptionCipherPacket(java.lang.Boolean&nbsp;acknowledgement,
java.lang.String[]&nbsp;cipherNames)</pre>
<div class="block">Constructs a new instance of NetworkEncryptionCipherPacket with the specified acknowledgement value and the specified ciphers.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>acknowledgement</code> - The acknowledgement value to use (Can be null).</dd>
<dd><code>cipherNames</code> - The cipher names.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - cipherNames 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="isAcknowledgement--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAcknowledgement</h4>
<pre>public&nbsp;boolean&nbsp;isAcknowledgement()</pre>
<div class="block">Gets if the class instance is an Acknowledgement.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IAcknowledgement.html#isAcknowledgement--">isAcknowledgement</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If the class instance is an Acknowledgement.</dd>
</dl>
</li>
</ul>
<a name="isValid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValid</h4>
<pre>public&nbsp;boolean&nbsp;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>&nbsp;in interface&nbsp;<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="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&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;getProtocol()</pre>
<div class="block">Gets the protocol information.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#getProtocol--">getProtocol</a></code>&nbsp;in interface&nbsp;<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="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&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;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="blockList">
<li class="blockList">
<h4>savePayload</h4>
<pre>public&nbsp;byte[]&nbsp;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>&nbsp;in interface&nbsp;<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="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>
<a name="loadPayload-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadPayload</h4>
<pre>public&nbsp;void&nbsp;loadPayload(byte[]&nbsp;packetData)
throws <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
<div class="block">Loads the packet payload from save data.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#loadPayload-byte:A-">loadPayload</a></code>&nbsp;in interface&nbsp;<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="paramLabel">Parameters:</span></dt>
<dd><code>packetData</code> - The packet payload data.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - The new store data is null.</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="readData-java.io.OutputStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readData</h4>
<pre>public&nbsp;void&nbsp;readData(java.io.OutputStream&nbsp;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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html#readData-java.io.OutputStream-">readData</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</a></code></dd>
<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>public&nbsp;void&nbsp;writeData(java.io.InputStream&nbsp;inputStream,
int&nbsp;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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html#writeData-java.io.InputStream-int-">writeData</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</a></code></dd>
<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="blockList">
<li class="blockList">
<h4>getSize</h4>
<pre>public&nbsp;int&nbsp;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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html#getSize--">getSize</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</a></code></dd>
<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>
<a name="getCiphers--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCiphers</h4>
<pre>public&nbsp;java.lang.String[]&nbsp;getCiphers()</pre>
<div class="block">Gets the cipher names this packet contains.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An array of cipher names.</dd>
</dl>
</li>
</ul>
<a name="setCiphers-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCiphers</h4>
<pre>public&nbsp;void&nbsp;setCiphers(java.lang.String[]&nbsp;cipherNames)</pre>
<div class="block">Sets the cipher names this packet contains.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cipherNames</code> - The array of cipher names.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - cipherNames is null.</dd>
</dl>
</li>
</ul>
<a name="isCacheUsed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCacheUsed</h4>
<pre>public&nbsp;boolean&nbsp;isCacheUsed()</pre>
<div class="block">Gets if the cipher information is cached.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IInternalCache.html#isCacheUsed--">isCacheUsed</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IInternalCache.html" title="interface in com.captainalm.lib.calmnet.packet">IInternalCache</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If the cipher information is cached.</dd>
</dl>
</li>
</ul>
<a name="setCacheUsed-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setCacheUsed</h4>
<pre>public&nbsp;void&nbsp;setCacheUsed(boolean&nbsp;used)</pre>
<div class="block">Sets if the cipher information is cached.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IInternalCache.html#setCacheUsed-boolean-">setCacheUsed</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IInternalCache.html" title="interface in com.captainalm.lib.calmnet.packet">IInternalCache</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>used</code> - If the cipher information is cached.</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/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" target="_top">Frames</a></li>
<li><a href="NetworkEncryptionCipherPacket.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>

View File

@ -0,0 +1,590 @@
<!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>NetworkEncryptionUpgradePacket</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="NetworkEncryptionUpgradePacket";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":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/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" target="_top">Frames</a></li>
<li><a href="NetworkEncryptionUpgradePacket.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.core</div>
<h2 title="Class NetworkEncryptionUpgradePacket" class="title">Class NetworkEncryptionUpgradePacket</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.packet.core.NetworkEncryptionUpgradePacket</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/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a>, <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">NetworkEncryptionUpgradePacket</span>
extends java.lang.Object
implements <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a></pre>
<div class="block">This class provides the ability for supporting streams to upgrade to using password encrypted and / or base64 connections.
This class can also signal the use changes for <a href="../../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core"><code>Base64Packet</code></a>s or <a href="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><code>EncryptedPacket</code></a>s.
<p>
Major ID: 255
Minor ID: 253
</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">&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/core/NetworkEncryptionUpgradePacket.html#NetworkEncryptionUpgradePacket-java.lang.Boolean-boolean-boolean-com.captainalm.lib.stdcrypt.encryption.ICipherFactory-">NetworkEncryptionUpgradePacket</a></span>(java.lang.Boolean&nbsp;acknowledgement,
boolean&nbsp;upgrade,
boolean&nbsp;base64ed,
com.captainalm.lib.stdcrypt.encryption.ICipherFactory&nbsp;cipherFactory)</code>
<div class="block">Constructs a new NetworkEncryptionUpgradePacket with the specified acknowledgement value, upgrade value, base 64 value and <code>ICipherFactory</code>.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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/core/NetworkEncryptionUpgradePacket.html#areSecretsSent--">areSecretsSent</a></span>()</code>
<div class="block">Gets if secrets are sent as part of cipher settings.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>com.captainalm.lib.stdcrypt.encryption.ICipherFactory</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#getCipherFactory--">getCipherFactory</a></span>()</code>
<div class="block">Gets the <code>ICipherFactory</code> being used or null.</div>
</td>
</tr>
<tr id="i2" 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/core/NetworkEncryptionUpgradePacket.html#getProtocol--">getProtocol</a></span>()</code>
<div class="block">Gets the protocol information.</div>
</td>
</tr>
<tr id="i3" 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/core/NetworkEncryptionUpgradePacket.html#getTheProtocol--">getTheProtocol</a></span>()</code>
<div class="block">Gets the protocol information statically.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#isAcknowledgement--">isAcknowledgement</a></span>()</code>
<div class="block">Gets if the class instance is an Acknowledgement.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#isBase64ed--">isBase64ed</a></span>()</code>
<div class="block">Gets if base 64 is used.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#isUpgrade--">isUpgrade</a></span>()</code>
<div class="block">Gets if the packet is treated as a stream upgrade or
a change in packet use for <a href="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><code>EncryptedPacket</code></a> and <a href="../../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core"><code>Base64Packet</code></a>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#isValid--">isValid</a></span>()</code>
<div class="block">Gets if the packet is valid.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#loadPayload-byte:A-">loadPayload</a></span>(byte[]&nbsp;packetData)</code>
<div class="block">Loads the packet payload from save data.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#savePayload--">savePayload</a></span>()</code>
<div class="block">Saves the packet payload to a byte array.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#setBase64ed-boolean-">setBase64ed</a></span>(boolean&nbsp;base64ed)</code>
<div class="block">Sets if base64 is used.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#setCipherFactory-com.captainalm.lib.stdcrypt.encryption.ICipherFactory-">setCipherFactory</a></span>(com.captainalm.lib.stdcrypt.encryption.ICipherFactory&nbsp;cipherFactory)</code>
<div class="block">Sets the <code>ICipherFactory</code> being used.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#setIfSecretsSent-boolean-">setIfSecretsSent</a></span>(boolean&nbsp;sendSecrets)</code>
<div class="block">Sets if secrets should be sent as part of cipher settings.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#setUpgrade-boolean-">setUpgrade</a></span>(boolean&nbsp;upgrade)</code>
<div class="block">Sets if the packet is treated as a stream upgrade or
a change in packet use for <a href="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><code>EncryptedPacket</code></a> and <a href="../../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core"><code>Base64Packet</code></a>.</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="NetworkEncryptionUpgradePacket-java.lang.Boolean-boolean-boolean-com.captainalm.lib.stdcrypt.encryption.ICipherFactory-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NetworkEncryptionUpgradePacket</h4>
<pre>public&nbsp;NetworkEncryptionUpgradePacket(java.lang.Boolean&nbsp;acknowledgement,
boolean&nbsp;upgrade,
boolean&nbsp;base64ed,
com.captainalm.lib.stdcrypt.encryption.ICipherFactory&nbsp;cipherFactory)</pre>
<div class="block">Constructs a new NetworkEncryptionUpgradePacket with the specified acknowledgement value, upgrade value, base 64 value and <code>ICipherFactory</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>acknowledgement</code> - The acknowledgement value to use (Can be null).</dd>
<dd><code>upgrade</code> - Is the packet treated as a stream upgrade, See: <a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#isUpgrade--"><code>isUpgrade()</code></a>.</dd>
<dd><code>base64ed</code> - Is the packet signalling base 64 to be used.</dd>
<dd><code>cipherFactory</code> - The cipherFactory to signal for use.</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&nbsp;boolean&nbsp;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>&nbsp;in interface&nbsp;<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="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&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;getProtocol()</pre>
<div class="block">Gets the protocol information.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#getProtocol--">getProtocol</a></code>&nbsp;in interface&nbsp;<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="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&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;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="blockList">
<li class="blockList">
<h4>savePayload</h4>
<pre>public&nbsp;byte[]&nbsp;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>&nbsp;in interface&nbsp;<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="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>
<a name="loadPayload-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadPayload</h4>
<pre>public&nbsp;void&nbsp;loadPayload(byte[]&nbsp;packetData)
throws <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
<div class="block">Loads the packet payload from save data.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#loadPayload-byte:A-">loadPayload</a></code>&nbsp;in interface&nbsp;<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="paramLabel">Parameters:</span></dt>
<dd><code>packetData</code> - The packet payload data.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - The new store data is null.</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="isUpgrade--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUpgrade</h4>
<pre>public&nbsp;boolean&nbsp;isUpgrade()</pre>
<div class="block">Gets if the packet is treated as a stream upgrade or
a change in packet use for <a href="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><code>EncryptedPacket</code></a> and <a href="../../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core"><code>Base64Packet</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If the packet is a stream upgrade.</dd>
</dl>
</li>
</ul>
<a name="setUpgrade-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUpgrade</h4>
<pre>public&nbsp;void&nbsp;setUpgrade(boolean&nbsp;upgrade)</pre>
<div class="block">Sets if the packet is treated as a stream upgrade or
a change in packet use for <a href="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><code>EncryptedPacket</code></a> and <a href="../../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core"><code>Base64Packet</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>upgrade</code> - If the packet is a stream upgrade.</dd>
</dl>
</li>
</ul>
<a name="isBase64ed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isBase64ed</h4>
<pre>public&nbsp;boolean&nbsp;isBase64ed()</pre>
<div class="block">Gets if base 64 is used.
(This is not for this packet, it is part of the upgrade attributes.)</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If base 64 is used.</dd>
</dl>
</li>
</ul>
<a name="setBase64ed-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBase64ed</h4>
<pre>public&nbsp;void&nbsp;setBase64ed(boolean&nbsp;base64ed)</pre>
<div class="block">Sets if base64 is used.
(This is not for this packet, it is part of the upgrade attributes.)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>base64ed</code> - If base 64 is to be used.</dd>
</dl>
</li>
</ul>
<a name="getCipherFactory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCipherFactory</h4>
<pre>public&nbsp;com.captainalm.lib.stdcrypt.encryption.ICipherFactory&nbsp;getCipherFactory()</pre>
<div class="block">Gets the <code>ICipherFactory</code> being used or null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The Cipher Factory or null.</dd>
</dl>
</li>
</ul>
<a name="setCipherFactory-com.captainalm.lib.stdcrypt.encryption.ICipherFactory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCipherFactory</h4>
<pre>public&nbsp;void&nbsp;setCipherFactory(com.captainalm.lib.stdcrypt.encryption.ICipherFactory&nbsp;cipherFactory)</pre>
<div class="block">Sets the <code>ICipherFactory</code> being used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cipherFactory</code> - The Cipher Factory or null.</dd>
</dl>
</li>
</ul>
<a name="isAcknowledgement--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAcknowledgement</h4>
<pre>public&nbsp;boolean&nbsp;isAcknowledgement()</pre>
<div class="block">Gets if the class instance is an Acknowledgement.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IAcknowledgement.html#isAcknowledgement--">isAcknowledgement</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If the class instance is an Acknowledgement.</dd>
</dl>
</li>
</ul>
<a name="areSecretsSent--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>areSecretsSent</h4>
<pre>public&nbsp;boolean&nbsp;areSecretsSent()</pre>
<div class="block">Gets if secrets are sent as part of cipher settings.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If the secrets are part of the cipher settings.</dd>
</dl>
</li>
</ul>
<a name="setIfSecretsSent-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setIfSecretsSent</h4>
<pre>public&nbsp;void&nbsp;setIfSecretsSent(boolean&nbsp;sendSecrets)</pre>
<div class="block">Sets if secrets should be sent as part of cipher settings.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sendSecrets</code> - If secrets are part of the cipher settings.</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/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" target="_top">Frames</a></li>
<li><a href="NetworkEncryptionUpgradePacket.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>

View File

@ -0,0 +1,392 @@
<!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>NetworkIdentifierPacket</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="NetworkIdentifierPacket";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":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/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html" target="_top">Frames</a></li>
<li><a href="NetworkIdentifierPacket.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.core</div>
<h2 title="Class NetworkIdentifierPacket" class="title">Class NetworkIdentifierPacket</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.packet.core.NetworkIdentifierPacket</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">NetworkIdentifierPacket</span>
extends java.lang.Object
implements <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></pre>
<div class="block">This class provides a packet that is used to identify the type of network client is using this library.
<p>
Major ID: 255
Minor ID: 255
</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">&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/core/NetworkIdentifierPacket.html#NetworkIdentifierPacket-java.lang.String-">NetworkIdentifierPacket</a></span>(java.lang.String&nbsp;id)</code>
<div class="block">Constructs a new instance of NetworkIdentifierPacket with the specified ID.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><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/core/NetworkIdentifierPacket.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/core/NetworkIdentifierPacket.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/core/NetworkIdentifierPacket.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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html#loadPayload-byte:A-">loadPayload</a></span>(byte[]&nbsp;packetData)</code>
<div class="block">Loads the packet payload from save data.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.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.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="NetworkIdentifierPacket-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NetworkIdentifierPacket</h4>
<pre>public&nbsp;NetworkIdentifierPacket(java.lang.String&nbsp;id)</pre>
<div class="block">Constructs a new instance of NetworkIdentifierPacket with the specified ID.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - The network ID of the client.</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&nbsp;boolean&nbsp;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>&nbsp;in interface&nbsp;<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="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&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;getProtocol()</pre>
<div class="block">Gets the protocol information.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#getProtocol--">getProtocol</a></code>&nbsp;in interface&nbsp;<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="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&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;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="blockList">
<li class="blockList">
<h4>savePayload</h4>
<pre>public&nbsp;byte[]&nbsp;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>&nbsp;in interface&nbsp;<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="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>
<a name="loadPayload-byte:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>loadPayload</h4>
<pre>public&nbsp;void&nbsp;loadPayload(byte[]&nbsp;packetData)
throws <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
<div class="block">Loads the packet payload from save data.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#loadPayload-byte:A-">loadPayload</a></code>&nbsp;in interface&nbsp;<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="paramLabel">Parameters:</span></dt>
<dd><code>packetData</code> - The packet payload data.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - The new store data is null.</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>
</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/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html" target="_top">Frames</a></li>
<li><a href="NetworkIdentifierPacket.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>

View File

@ -0,0 +1,414 @@
<!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>NetworkSSLUpgradePacket</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="NetworkSSLUpgradePacket";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10,"i5":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/core/NetworkIdentifierPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html" target="_top">Frames</a></li>
<li><a href="NetworkSSLUpgradePacket.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.core</div>
<h2 title="Class NetworkSSLUpgradePacket" class="title">Class NetworkSSLUpgradePacket</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.packet.core.NetworkSSLUpgradePacket</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/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a>, <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">NetworkSSLUpgradePacket</span>
extends java.lang.Object
implements <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a></pre>
<div class="block">This class provides the ability for supporting streams to upgrade to using SSL connections.
<p>
Major ID: 255
Minor ID: 254
</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">&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/core/NetworkSSLUpgradePacket.html#NetworkSSLUpgradePacket-java.lang.Boolean-">NetworkSSLUpgradePacket</a></span>(java.lang.Boolean&nbsp;acknowledgement)</code>
<div class="block">Constructs a new NetworkSSLUpgrade packet with the specified acknowledgement value.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><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/core/NetworkSSLUpgradePacket.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/core/NetworkSSLUpgradePacket.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/core/NetworkSSLUpgradePacket.html#isAcknowledgement--">isAcknowledgement</a></span>()</code>
<div class="block">Gets if the class instance is an Acknowledgement.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html#isValid--">isValid</a></span>()</code>
<div class="block">Gets if the packet is valid.</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/core/NetworkSSLUpgradePacket.html#loadPayload-byte:A-">loadPayload</a></span>(byte[]&nbsp;packetData)</code>
<div class="block">Loads the packet payload from save data.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.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.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="NetworkSSLUpgradePacket-java.lang.Boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NetworkSSLUpgradePacket</h4>
<pre>public&nbsp;NetworkSSLUpgradePacket(java.lang.Boolean&nbsp;acknowledgement)</pre>
<div class="block">Constructs a new NetworkSSLUpgrade packet with the specified acknowledgement value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>acknowledgement</code> - The acknowledgement value to use (Can be 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="isValid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValid</h4>
<pre>public&nbsp;boolean&nbsp;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>&nbsp;in interface&nbsp;<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="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&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;getProtocol()</pre>
<div class="block">Gets the protocol information.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#getProtocol--">getProtocol</a></code>&nbsp;in interface&nbsp;<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="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&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;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="blockList">
<li class="blockList">
<h4>savePayload</h4>
<pre>public&nbsp;byte[]&nbsp;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>&nbsp;in interface&nbsp;<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="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>
<a name="loadPayload-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadPayload</h4>
<pre>public&nbsp;void&nbsp;loadPayload(byte[]&nbsp;packetData)
throws <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
<div class="block">Loads the packet payload from save data.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#loadPayload-byte:A-">loadPayload</a></code>&nbsp;in interface&nbsp;<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="paramLabel">Parameters:</span></dt>
<dd><code>packetData</code> - The packet payload data.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - The new store data is null.</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="isAcknowledgement--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isAcknowledgement</h4>
<pre>public&nbsp;boolean&nbsp;isAcknowledgement()</pre>
<div class="block">Gets if the class instance is an Acknowledgement.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IAcknowledgement.html#isAcknowledgement--">isAcknowledgement</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If the class instance is an Acknowledgement.</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/core/NetworkIdentifierPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html" target="_top">Frames</a></li>
<li><a href="NetworkSSLUpgradePacket.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>

View File

@ -0,0 +1,25 @@
<!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:22 BST 2023 -->
<title>com.captainalm.lib.calmnet.packet.core</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>
<h1 class="bar"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/package-summary.html" target="classFrame">com.captainalm.lib.calmnet.packet.core</a></h1>
<div class="indexContainer">
<h2 title="Classes">Classes</h2>
<ul title="Classes">
<li><a href="Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core" target="classFrame">Base64Packet</a></li>
<li><a href="EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core" target="classFrame">EncryptedPacket</a></li>
<li><a href="NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core" target="classFrame">NetworkEncryptionCipherPacket</a></li>
<li><a href="NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core" target="classFrame">NetworkEncryptionUpgradePacket</a></li>
<li><a href="NetworkIdentifierPacket.html" title="class in com.captainalm.lib.calmnet.packet.core" target="classFrame">NetworkIdentifierPacket</a></li>
<li><a href="NetworkSSLUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core" target="classFrame">NetworkSSLUpgradePacket</a></li>
</ul>
</div>
</body>
</html>

View File

@ -0,0 +1,188 @@
<!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:22 BST 2023 -->
<title>com.captainalm.lib.calmnet.packet.core</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="com.captainalm.lib.calmnet.packet.core";
}
}
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/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/core/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.core</h1>
<div class="docSummary">
<div class="block">This package contains the core network packets.</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/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core">Base64Packet</a></td>
<td class="colLast">
<div class="block">This class provides a base64 encrypted packet that can hold an <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></td>
<td class="colLast">
<div class="block">This class provides an encrypted packet that can hold an <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionCipherPacket</a></td>
<td class="colLast">
<div class="block">This class provides the ability for supporting streams to negotiate a cipher.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionUpgradePacket</a></td>
<td class="colLast">
<div class="block">This class provides the ability for supporting streams to upgrade to using password encrypted and / or base64 connections.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkIdentifierPacket</a></td>
<td class="colLast">
<div class="block">This class provides a packet that is used to identify the type of network client is using this library.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkSSLUpgradePacket</a></td>
<td class="colLast">
<div class="block">This class provides the ability for supporting streams to upgrade to using SSL connections.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package com.captainalm.lib.calmnet.packet.core Description">Package com.captainalm.lib.calmnet.packet.core Description</h2>
<div class="block">This package contains the core network packets.
<p>
Major ID: 255
</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/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/core/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>

View File

@ -0,0 +1,140 @@
<!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:22 BST 2023 -->
<title>com.captainalm.lib.calmnet.packet.core Class Hierarchy</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="com.captainalm.lib.calmnet.packet.core Class Hierarchy";
}
}
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><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</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/package-tree.html">Prev</a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/package-tree.html">Next</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/core/package-tree.html" target="_top">Frames</a></li>
<li><a href="package-tree.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 class="title">Hierarchy For Package com.captainalm.lib.calmnet.packet.core</h1>
<span class="packageHierarchyLabel">Package Hierarchies:</span>
<ul class="horizontal">
<li><a href="../../../../../../overview-tree.html">All Packages</a></li>
</ul>
</div>
<div class="contentContainer">
<h2 title="Class Hierarchy">Class Hierarchy</h2>
<ul>
<li type="circle">java.lang.Object
<ul>
<li type="circle">com.captainalm.lib.calmnet.packet.core.<a href="../../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">Base64Packet</span></a> (implements com.captainalm.lib.calmnet.packet.<a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</a>)</li>
<li type="circle">com.captainalm.lib.calmnet.packet.core.<a href="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">EncryptedPacket</span></a> (implements com.captainalm.lib.calmnet.packet.<a href="../../../../../../com/captainalm/lib/calmnet/packet/IInternalCache.html" title="interface in com.captainalm.lib.calmnet.packet">IInternalCache</a>, com.captainalm.lib.calmnet.packet.<a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</a>)</li>
<li type="circle">com.captainalm.lib.calmnet.packet.core.<a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">NetworkEncryptionCipherPacket</span></a> (implements com.captainalm.lib.calmnet.packet.<a href="../../../../../../com/captainalm/lib/calmnet/packet/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a>, com.captainalm.lib.calmnet.packet.<a href="../../../../../../com/captainalm/lib/calmnet/packet/IInternalCache.html" title="interface in com.captainalm.lib.calmnet.packet">IInternalCache</a>, com.captainalm.lib.calmnet.packet.<a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</a>)</li>
<li type="circle">com.captainalm.lib.calmnet.packet.core.<a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">NetworkEncryptionUpgradePacket</span></a> (implements com.captainalm.lib.calmnet.packet.<a href="../../../../../../com/captainalm/lib/calmnet/packet/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a>, com.captainalm.lib.calmnet.packet.<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>)</li>
<li type="circle">com.captainalm.lib.calmnet.packet.core.<a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">NetworkIdentifierPacket</span></a> (implements com.captainalm.lib.calmnet.packet.<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>)</li>
<li type="circle">com.captainalm.lib.calmnet.packet.core.<a href="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">NetworkSSLUpgradePacket</span></a> (implements com.captainalm.lib.calmnet.packet.<a href="../../../../../../com/captainalm/lib/calmnet/packet/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a>, com.captainalm.lib.calmnet.packet.<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>)</li>
</ul>
</li>
</ul>
</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><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</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/package-tree.html">Prev</a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/package-tree.html">Next</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/core/package-tree.html" target="_top">Frames</a></li>
<li><a href="package-tree.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>

View File

@ -0,0 +1,501 @@
<!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>CALMNETPacketFactory</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="CALMNETPacketFactory";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":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>Prev&nbsp;Class</li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactoryWithPacket.html" title="class in com.captainalm.lib.calmnet.packet.factory"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html" target="_top">Frames</a></li>
<li><a href="CALMNETPacketFactory.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.factory</div>
<h2 title="Class CALMNETPacketFactory" class="title">Class CALMNETPacketFactory</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.packet.factory.CALMNETPacketFactory</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/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactoryWithPacket.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactoryWithPacket</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">CALMNETPacketFactory</span>
extends java.lang.Object
implements <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a></pre>
<div class="block">This class provides a standard extensible <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a> for calmnet packets.</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/factory/CALMNETPacketFactory.html#CALMNETPacketFactory-boolean-com.captainalm.lib.calmnet.packet.PacketLoader-">CALMNETPacketFactory</a></span>(boolean&nbsp;preferStreamPackets,
<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">Constructs a new Instance of CALMNETPacketFactory with if <a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a>s are preferred and the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#CALMNETPacketFactory-boolean-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-">CALMNETPacketFactory</a></span>(boolean&nbsp;preferStreamPackets,
<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 Instance of CALMNETPacketFactory with if <a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a>s are preferred, the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a> and the <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/factory/CALMNETPacketFactory.html#areStreamPacketsPreferred--">areStreamPacketsPreferred</a></span>()</code>
<div class="block">Gets if <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#getPacket-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-"><code>getPacket(PacketProtocolInformation)</code></a> prefers returning <a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a>s if possible.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>com.captainalm.lib.stdcrypt.encryption.ICipherFactory</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#getCipherFactory--">getCipherFactory</a></span>()</code>
<div class="block">Gets the <code>ICipherFactory</code> in use (Could be the same instance).</div>
</td>
</tr>
<tr id="i2" 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/factory/CALMNETPacketFactory.html#getPacket-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">getPacket</a></span>(<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;information)</code>
<div class="block">Constructs a <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> of the protocol specified by the passed <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketProtocolInformation</code></a> instance.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<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/factory/CALMNETPacketFactory.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 (Could be the same instance).</div>
</td>
</tr>
<tr id="i4" class="altColor">
<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/factory/CALMNETPacketFactory.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="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#setCipherFactory-com.captainalm.lib.stdcrypt.encryption.ICipherFactory-">setCipherFactory</a></span>(com.captainalm.lib.stdcrypt.encryption.ICipherFactory&nbsp;factory)</code>
<div class="block">Sets the <code>ICipherFactory</code> in use.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.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> in use (null signifies to use the same instance).</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.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="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#setStreamPacketsPreferred-boolean-">setStreamPacketsPreferred</a></span>(boolean&nbsp;preferred)</code>
<div class="block">Sets if <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#getPacket-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-"><code>getPacket(PacketProtocolInformation)</code></a> prefers returning <a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a>s if possible.</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="CALMNETPacketFactory-boolean-com.captainalm.lib.calmnet.packet.PacketLoader-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CALMNETPacketFactory</h4>
<pre>public&nbsp;CALMNETPacketFactory(boolean&nbsp;preferStreamPackets,
<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">Constructs a new Instance of CALMNETPacketFactory with if <a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a>s are preferred and the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>preferStreamPackets</code> - If streamed packets are preferred for construction.</dd>
<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="CALMNETPacketFactory-boolean-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CALMNETPacketFactory</h4>
<pre>public&nbsp;CALMNETPacketFactory(boolean&nbsp;preferStreamPackets,
<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 Instance of CALMNETPacketFactory with if <a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a>s are preferred, the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a> and the <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>preferStreamPackets</code> - If streamed packets are preferred for construction.</dd>
<dd><code>loader</code> - The packet loader to use.</dd>
<dd><code>factory</code> - The packet factory to use or null (null signifies to use the same instance).</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - loader 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="getPacket-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPacket</h4>
<pre>public&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;getPacket(<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;information)</pre>
<div class="block">Constructs a <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> of the protocol specified by the passed <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketProtocolInformation</code></a> instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html#getPacket-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">getPacket</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>information</code> - The protocol information to use.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The constructed packet or null.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - The information is null.</dd>
</dl>
</li>
</ul>
<a name="areStreamPacketsPreferred--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>areStreamPacketsPreferred</h4>
<pre>public&nbsp;boolean&nbsp;areStreamPacketsPreferred()</pre>
<div class="block">Gets if <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#getPacket-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-"><code>getPacket(PacketProtocolInformation)</code></a> prefers returning <a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a>s if possible.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html#areStreamPacketsPreferred--">areStreamPacketsPreferred</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If streamed packets are preferred for construction.</dd>
</dl>
</li>
</ul>
<a name="setStreamPacketsPreferred-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStreamPacketsPreferred</h4>
<pre>public&nbsp;void&nbsp;setStreamPacketsPreferred(boolean&nbsp;preferred)</pre>
<div class="block">Sets if <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#getPacket-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-"><code>getPacket(PacketProtocolInformation)</code></a> prefers returning <a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a>s if possible.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html#setStreamPacketsPreferred-boolean-">setStreamPacketsPreferred</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>preferred</code> - If streamed packets are preferred for construction.</dd>
</dl>
</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 (Could be the same instance).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The packet factory 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> in use (null signifies to use the same instance).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - The packet factory to use or 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 packet loader 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="getCipherFactory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCipherFactory</h4>
<pre>public&nbsp;com.captainalm.lib.stdcrypt.encryption.ICipherFactory&nbsp;getCipherFactory()</pre>
<div class="block">Gets the <code>ICipherFactory</code> in use (Could be the same instance).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The cipher factory in use.</dd>
</dl>
</li>
</ul>
<a name="setCipherFactory-com.captainalm.lib.stdcrypt.encryption.ICipherFactory-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setCipherFactory</h4>
<pre>public&nbsp;void&nbsp;setCipherFactory(com.captainalm.lib.stdcrypt.encryption.ICipherFactory&nbsp;factory)</pre>
<div class="block">Sets the <code>ICipherFactory</code> in use.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - The cipher factory to use or null.</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>Prev&nbsp;Class</li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactoryWithPacket.html" title="class in com.captainalm.lib.calmnet.packet.factory"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html" target="_top">Frames</a></li>
<li><a href="CALMNETPacketFactory.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>

View File

@ -0,0 +1,385 @@
<!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>CALMNETPacketFactoryWithPacket</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="CALMNETPacketFactoryWithPacket";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":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/factory/CALMNETPacketFactory.html" title="class in com.captainalm.lib.calmnet.packet.factory"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactoryWithPacket.html" target="_top">Frames</a></li>
<li><a href="CALMNETPacketFactoryWithPacket.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.factory</div>
<h2 title="Class CALMNETPacketFactoryWithPacket" class="title">Class CALMNETPacketFactoryWithPacket</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/factory/CALMNETPacketFactory.html" title="class in com.captainalm.lib.calmnet.packet.factory">com.captainalm.lib.calmnet.packet.factory.CALMNETPacketFactory</a></li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.packet.factory.CALMNETPacketFactoryWithPacket</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/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">CALMNETPacketFactoryWithPacket</span>
extends <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactory</a></pre>
<div class="block">This class provides a standard extensible <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a> for calmnet packets
with the ability to set the <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> of supporting packets.</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/factory/CALMNETPacketFactoryWithPacket.html#CALMNETPacketFactoryWithPacket-boolean-com.captainalm.lib.calmnet.packet.PacketLoader-">CALMNETPacketFactoryWithPacket</a></span>(boolean&nbsp;preferStreamPackets,
<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">Constructs a new Instance of CALMNETPacketFactoryWithPacket with if <a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a>s are preferred and the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactoryWithPacket.html#CALMNETPacketFactoryWithPacket-boolean-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-">CALMNETPacketFactoryWithPacket</a></span>(boolean&nbsp;preferStreamPackets,
<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 Instance of CALMNETPacketFactoryWithPacket with if <a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a>s are preferred, the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a> and the <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><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/factory/CALMNETPacketFactoryWithPacket.html#getPacket--">getPacket</a></span>()</code>
<div class="block">Gets the <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> in use (Could be the same instance).</div>
</td>
</tr>
<tr id="i1" 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/factory/CALMNETPacketFactoryWithPacket.html#getPacket-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">getPacket</a></span>(<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;information)</code>
<div class="block">Constructs a <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> of the protocol specified by the passed <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketProtocolInformation</code></a> instance.</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/factory/CALMNETPacketFactoryWithPacket.html#setPacket-com.captainalm.lib.calmnet.packet.IPacket-">setPacket</a></span>(<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packet)</code>
<div class="block">Sets the <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> in use.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.captainalm.lib.calmnet.packet.factory.CALMNETPacketFactory">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.captainalm.lib.calmnet.packet.factory.<a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactory</a></h3>
<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#areStreamPacketsPreferred--">areStreamPacketsPreferred</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#getCipherFactory--">getCipherFactory</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#getPacketFactory--">getPacketFactory</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#getPacketLoader--">getPacketLoader</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#setCipherFactory-com.captainalm.lib.stdcrypt.encryption.ICipherFactory-">setCipherFactory</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#setPacketFactory-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-">setPacketFactory</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#setPacketLoader-com.captainalm.lib.calmnet.packet.PacketLoader-">setPacketLoader</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#setStreamPacketsPreferred-boolean-">setStreamPacketsPreferred</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&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="CALMNETPacketFactoryWithPacket-boolean-com.captainalm.lib.calmnet.packet.PacketLoader-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CALMNETPacketFactoryWithPacket</h4>
<pre>public&nbsp;CALMNETPacketFactoryWithPacket(boolean&nbsp;preferStreamPackets,
<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">Constructs a new Instance of CALMNETPacketFactoryWithPacket with if <a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a>s are preferred and the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>preferStreamPackets</code> - If streamed packets are preferred for construction.</dd>
<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="CALMNETPacketFactoryWithPacket-boolean-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CALMNETPacketFactoryWithPacket</h4>
<pre>public&nbsp;CALMNETPacketFactoryWithPacket(boolean&nbsp;preferStreamPackets,
<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 Instance of CALMNETPacketFactoryWithPacket with if <a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a>s are preferred, the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a> and the <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>preferStreamPackets</code> - If streamed packets are preferred for construction.</dd>
<dd><code>loader</code> - The packet loader to use.</dd>
<dd><code>factory</code> - The packet factory to use or null (null signifies to use the same instance).</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - loader 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="getPacket-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPacket</h4>
<pre>public&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;getPacket(<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;information)</pre>
<div class="block">Constructs a <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> of the protocol specified by the passed <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketProtocolInformation</code></a> instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html#getPacket-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">getPacket</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#getPacket-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">getPacket</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactory</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>information</code> - The protocol information to use.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The constructed packet or null.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - The information is null.</dd>
</dl>
</li>
</ul>
<a name="getPacket--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPacket</h4>
<pre>public&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;getPacket()</pre>
<div class="block">Gets the <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> in use (Could be the same instance).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The packet in use.</dd>
</dl>
</li>
</ul>
<a name="setPacket-com.captainalm.lib.calmnet.packet.IPacket-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setPacket</h4>
<pre>public&nbsp;void&nbsp;setPacket(<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packet)</pre>
<div class="block">Sets the <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> in use.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>packet</code> - The packet to use or null.</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/factory/CALMNETPacketFactory.html" title="class in com.captainalm.lib.calmnet.packet.factory"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactoryWithPacket.html" target="_top">Frames</a></li>
<li><a href="CALMNETPacketFactoryWithPacket.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>

View File

@ -0,0 +1,279 @@
<!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>IPacketFactory</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="IPacketFactory";
}
}
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/factory/CALMNETPacketFactoryWithPacket.html" title="class in com.captainalm.lib.calmnet.packet.factory"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" target="_top">Frames</a></li>
<li><a href="IPacketFactory.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>Constr&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>Constr&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.factory</div>
<h2 title="Interface IPacketFactory" class="title">Interface IPacketFactory</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactory</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactoryWithPacket.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactoryWithPacket</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">IPacketFactory</span></pre>
<div class="block">This interface provides the ability to construct <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>s given their <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketProtocolInformation</code></a>.</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">&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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/factory/IPacketFactory.html#areStreamPacketsPreferred--">areStreamPacketsPreferred</a></span>()</code>
<div class="block">Gets if <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html#getPacket-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-"><code>getPacket(PacketProtocolInformation)</code></a> prefers returning <a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a>s if possible.</div>
</td>
</tr>
<tr id="i1" 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/factory/IPacketFactory.html#getPacket-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">getPacket</a></span>(<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;information)</code>
<div class="block">Constructs a <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> of the protocol specified by the passed <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketProtocolInformation</code></a> instance.</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/factory/IPacketFactory.html#setStreamPacketsPreferred-boolean-">setStreamPacketsPreferred</a></span>(boolean&nbsp;preferred)</code>
<div class="block">Sets if <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html#getPacket-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-"><code>getPacket(PacketProtocolInformation)</code></a> prefers returning <a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a>s if possible.</div>
</td>
</tr>
</table>
</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="getPacket-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPacket</h4>
<pre><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;getPacket(<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;information)</pre>
<div class="block">Constructs a <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> of the protocol specified by the passed <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketProtocolInformation</code></a> instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>information</code> - The protocol information to use.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The constructed packet or null.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - The information is null.</dd>
</dl>
</li>
</ul>
<a name="areStreamPacketsPreferred--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>areStreamPacketsPreferred</h4>
<pre>boolean&nbsp;areStreamPacketsPreferred()</pre>
<div class="block">Gets if <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html#getPacket-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-"><code>getPacket(PacketProtocolInformation)</code></a> prefers returning <a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a>s if possible.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If streamed packets are preferred for construction.</dd>
</dl>
</li>
</ul>
<a name="setStreamPacketsPreferred-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setStreamPacketsPreferred</h4>
<pre>void&nbsp;setStreamPacketsPreferred(boolean&nbsp;preferred)</pre>
<div class="block">Sets if <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html#getPacket-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-"><code>getPacket(PacketProtocolInformation)</code></a> prefers returning <a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a>s if possible.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>preferred</code> - If streamed packets are preferred for construction.</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/factory/CALMNETPacketFactoryWithPacket.html" title="class in com.captainalm.lib.calmnet.packet.factory"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" target="_top">Frames</a></li>
<li><a href="IPacketFactory.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>Constr&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>Constr&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>

View File

@ -0,0 +1,25 @@
<!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:22 BST 2023 -->
<title>com.captainalm.lib.calmnet.packet.factory</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>
<h1 class="bar"><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/package-summary.html" target="classFrame">com.captainalm.lib.calmnet.packet.factory</a></h1>
<div class="indexContainer">
<h2 title="Interfaces">Interfaces</h2>
<ul title="Interfaces">
<li><a href="IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory" target="classFrame"><span class="interfaceName">IPacketFactory</span></a></li>
</ul>
<h2 title="Classes">Classes</h2>
<ul title="Classes">
<li><a href="CALMNETPacketFactory.html" title="class in com.captainalm.lib.calmnet.packet.factory" target="classFrame">CALMNETPacketFactory</a></li>
<li><a href="CALMNETPacketFactoryWithPacket.html" title="class in com.captainalm.lib.calmnet.packet.factory" target="classFrame">CALMNETPacketFactoryWithPacket</a></li>
</ul>
</div>
</body>
</html>

View File

@ -0,0 +1,179 @@
<!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:22 BST 2023 -->
<title>com.captainalm.lib.calmnet.packet.factory</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="com.captainalm.lib.calmnet.packet.factory";
}
}
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/core/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/factory/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.factory</h1>
<div class="docSummary">
<div class="block">This package contains the <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a> interface and standard classes.</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="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a></td>
<td class="colLast">
<div class="block">This interface provides the ability to construct <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>s given their <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketProtocolInformation</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<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/factory/CALMNETPacketFactory.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactory</a></td>
<td class="colLast">
<div class="block">This class provides a standard extensible <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a> for calmnet packets.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactoryWithPacket.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactoryWithPacket</a></td>
<td class="colLast">
<div class="block">This class provides a standard extensible <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a> for calmnet packets
with the ability to set the <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> of supporting packets.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package com.captainalm.lib.calmnet.packet.factory Description">Package com.captainalm.lib.calmnet.packet.factory Description</h2>
<div class="block">This package contains the <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a> interface and standard classes.</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/core/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/factory/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>

View File

@ -0,0 +1,143 @@
<!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:22 BST 2023 -->
<title>com.captainalm.lib.calmnet.packet.factory Class Hierarchy</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="com.captainalm.lib.calmnet.packet.factory Class Hierarchy";
}
}
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><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</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/core/package-tree.html">Prev</a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/package-tree.html">Next</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/factory/package-tree.html" target="_top">Frames</a></li>
<li><a href="package-tree.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 class="title">Hierarchy For Package com.captainalm.lib.calmnet.packet.factory</h1>
<span class="packageHierarchyLabel">Package Hierarchies:</span>
<ul class="horizontal">
<li><a href="../../../../../../overview-tree.html">All Packages</a></li>
</ul>
</div>
<div class="contentContainer">
<h2 title="Class Hierarchy">Class Hierarchy</h2>
<ul>
<li type="circle">java.lang.Object
<ul>
<li type="circle">com.captainalm.lib.calmnet.packet.factory.<a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html" title="class in com.captainalm.lib.calmnet.packet.factory"><span class="typeNameLink">CALMNETPacketFactory</span></a> (implements com.captainalm.lib.calmnet.packet.factory.<a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>)
<ul>
<li type="circle">com.captainalm.lib.calmnet.packet.factory.<a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactoryWithPacket.html" title="class in com.captainalm.lib.calmnet.packet.factory"><span class="typeNameLink">CALMNETPacketFactoryWithPacket</span></a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h2 title="Interface Hierarchy">Interface Hierarchy</h2>
<ul>
<li type="circle">com.captainalm.lib.calmnet.packet.factory.<a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><span class="typeNameLink">IPacketFactory</span></a></li>
</ul>
</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><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</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/core/package-tree.html">Prev</a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/package-tree.html">Next</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/factory/package-tree.html" target="_top">Frames</a></li>
<li><a href="package-tree.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>

View File

@ -0,0 +1,438 @@
<!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>FragmentAllocatePacket</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="FragmentAllocatePacket";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":10,"i5":10,"i6":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>Prev&nbsp;Class</li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.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/FragmentAllocatePacket.html" target="_top">Frames</a></li>
<li><a href="FragmentAllocatePacket.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 FragmentAllocatePacket" class="title">Class FragmentAllocatePacket</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.packet.fragment.FragmentAllocatePacket</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">FragmentAllocatePacket</span>
extends java.lang.Object
implements <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></pre>
<div class="block">This class provides a packet for fragment allocation requesting.
The response packet is: <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentAllocationPacket</code></a>.
<p>
Major ID: 254
Minor ID: 1
</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">&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/FragmentAllocatePacket.html#FragmentAllocatePacket-java.lang.Integer-java.util.UUID-">FragmentAllocatePacket</a></span>(java.lang.Integer&nbsp;fragmentCount,
java.util.UUID&nbsp;allocationID)</code>
<div class="block">Constructs a new FragmentAllocatePacket given the fragment count and allocation UUID.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>java.util.UUID</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html#getAllocationID--">getAllocationID</a></span>()</code>
<div class="block">Gets the allocation ID or null.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.Integer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html#getFragmentCount--">getFragmentCount</a></span>()</code>
<div class="block">Gets the number of fragments or null.</div>
</td>
</tr>
<tr id="i2" 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/FragmentAllocatePacket.html#getProtocol--">getProtocol</a></span>()</code>
<div class="block">Gets the protocol information.</div>
</td>
</tr>
<tr id="i3" 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/FragmentAllocatePacket.html#getTheProtocol--">getTheProtocol</a></span>()</code>
<div class="block">Gets the protocol information statically.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html#isValid--">isValid</a></span>()</code>
<div class="block">Gets if the packet is valid.</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/FragmentAllocatePacket.html#loadPayload-byte:A-">loadPayload</a></span>(byte[]&nbsp;packetData)</code>
<div class="block">Loads the packet payload from save data.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.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.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="FragmentAllocatePacket-java.lang.Integer-java.util.UUID-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FragmentAllocatePacket</h4>
<pre>public&nbsp;FragmentAllocatePacket(java.lang.Integer&nbsp;fragmentCount,
java.util.UUID&nbsp;allocationID)</pre>
<div class="block">Constructs a new FragmentAllocatePacket given the fragment count and allocation UUID.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fragmentCount</code> - The number of fragments to allocate.</dd>
<dd><code>allocationID</code> - The allocation ID.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - fragmentCount is less than 1.</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&nbsp;boolean&nbsp;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>&nbsp;in interface&nbsp;<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="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&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;getProtocol()</pre>
<div class="block">Gets the protocol information.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#getProtocol--">getProtocol</a></code>&nbsp;in interface&nbsp;<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="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&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;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="blockList">
<li class="blockList">
<h4>savePayload</h4>
<pre>public&nbsp;byte[]&nbsp;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>&nbsp;in interface&nbsp;<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="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>
<a name="loadPayload-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadPayload</h4>
<pre>public&nbsp;void&nbsp;loadPayload(byte[]&nbsp;packetData)
throws <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
<div class="block">Loads the packet payload from save data.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#loadPayload-byte:A-">loadPayload</a></code>&nbsp;in interface&nbsp;<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="paramLabel">Parameters:</span></dt>
<dd><code>packetData</code> - The packet payload data.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - The new store data is null.</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="getFragmentCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFragmentCount</h4>
<pre>public&nbsp;java.lang.Integer&nbsp;getFragmentCount()</pre>
<div class="block">Gets the number of fragments or null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of fragments or null.</dd>
</dl>
</li>
</ul>
<a name="getAllocationID--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getAllocationID</h4>
<pre>public&nbsp;java.util.UUID&nbsp;getAllocationID()</pre>
<div class="block">Gets the allocation ID or null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The allocation ID or null.</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>Prev&nbsp;Class</li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.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/FragmentAllocatePacket.html" target="_top">Frames</a></li>
<li><a href="FragmentAllocatePacket.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>

View File

@ -0,0 +1,448 @@
<!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>FragmentAllocationPacket</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="FragmentAllocationPacket";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":10,"i5":10,"i6":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/FragmentAllocatePacket.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/FragmentMessagePacket.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/FragmentAllocationPacket.html" target="_top">Frames</a></li>
<li><a href="FragmentAllocationPacket.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 FragmentAllocationPacket" class="title">Class FragmentAllocationPacket</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>com.captainalm.lib.calmnet.packet.fragment.FragmentAllocationPacket</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">FragmentAllocationPacket</span>
extends <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDPacket</a></pre>
<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>.
<p>
Major ID: 254
Minor ID: 2
</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">&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/FragmentAllocationPacket.html#FragmentAllocationPacket-java.lang.Integer-java.util.UUID-java.lang.Boolean-">FragmentAllocationPacket</a></span>(java.lang.Integer&nbsp;packetID,
java.util.UUID&nbsp;allocationID,
java.lang.Boolean&nbsp;success)</code>
<div class="block">Constructs a new FragmentAllocationPacket given the packet ID, allocation ID and if it's successful.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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/FragmentAllocationPacket.html#allocationSuccessful--">allocationSuccessful</a></span>()</code>
<div class="block">Checks if the allocation is successful.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.UUID</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html#getAllocationID--">getAllocationID</a></span>()</code>
<div class="block">Gets the allocation ID or null.</div>
</td>
</tr>
<tr id="i2" 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/FragmentAllocationPacket.html#getProtocol--">getProtocol</a></span>()</code>
<div class="block">Gets the protocol information.</div>
</td>
</tr>
<tr id="i3" 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/FragmentAllocationPacket.html#getTheProtocol--">getTheProtocol</a></span>()</code>
<div class="block">Gets the protocol information statically.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html#isValid--">isValid</a></span>()</code>
<div class="block">Gets if the packet is valid.</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/FragmentAllocationPacket.html#loadPayload-byte:A-">loadPayload</a></span>(byte[]&nbsp;packetData)</code>
<div class="block">Loads the packet payload from save data.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.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.FragmentPIDPacket">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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&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="FragmentAllocationPacket-java.lang.Integer-java.util.UUID-java.lang.Boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FragmentAllocationPacket</h4>
<pre>public&nbsp;FragmentAllocationPacket(java.lang.Integer&nbsp;packetID,
java.util.UUID&nbsp;allocationID,
java.lang.Boolean&nbsp;success)</pre>
<div class="block">Constructs a new FragmentAllocationPacket given the packet ID, allocation ID and if it's successful.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>packetID</code> - The packet ID.</dd>
<dd><code>allocationID</code> - The allocation ID.</dd>
<dd><code>success</code> - The allocation was successful.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - packetID 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&nbsp;boolean&nbsp;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>&nbsp;in interface&nbsp;<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/FragmentPIDPacket.html#isValid--">isValid</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDPacket</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&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;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&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;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="blockList">
<li class="blockList">
<h4>savePayload</h4>
<pre>public&nbsp;byte[]&nbsp;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="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>
<a name="loadPayload-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadPayload</h4>
<pre>public&nbsp;void&nbsp;loadPayload(byte[]&nbsp;packetData)
throws <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
<div class="block">Loads the packet payload from save data.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>packetData</code> - The packet payload data.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - The new store data is null.</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="allocationSuccessful--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allocationSuccessful</h4>
<pre>public&nbsp;boolean&nbsp;allocationSuccessful()</pre>
<div class="block">Checks if the allocation is successful.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If the allocation was successful.</dd>
</dl>
</li>
</ul>
<a name="getAllocationID--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getAllocationID</h4>
<pre>public&nbsp;java.util.UUID&nbsp;getAllocationID()</pre>
<div class="block">Gets the allocation ID or null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The allocation ID or null.</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/FragmentAllocatePacket.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/FragmentMessagePacket.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/FragmentAllocationPacket.html" target="_top">Frames</a></li>
<li><a href="FragmentAllocationPacket.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>

View File

@ -0,0 +1,400 @@
<!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&nbsp;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&nbsp;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&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 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">&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/FragmentMessagePacket.html#FragmentMessagePacket-java.lang.Integer-java.lang.Integer-byte:A-">FragmentMessagePacket</a></span>(java.lang.Integer&nbsp;packetID,
java.lang.Integer&nbsp;fragmentID,
byte[]&nbsp;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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><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&nbsp;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&nbsp;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&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="FragmentMessagePacket-java.lang.Integer-java.lang.Integer-byte:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FragmentMessagePacket</h4>
<pre>public&nbsp;FragmentMessagePacket(java.lang.Integer&nbsp;packetID,
java.lang.Integer&nbsp;fragmentID,
byte[]&nbsp;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&nbsp;boolean&nbsp;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>&nbsp;in interface&nbsp;<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>&nbsp;in class&nbsp;<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&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;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&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;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&nbsp;byte[]&nbsp;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>&nbsp;in interface&nbsp;<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>&nbsp;in class&nbsp;<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&nbsp;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&nbsp;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&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>

View File

@ -0,0 +1,349 @@
<!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>FragmentMessageResponsePacket</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="FragmentMessageResponsePacket";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9};
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/FragmentMessagePacket.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/FragmentPIDAKNPacket.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/FragmentMessageResponsePacket.html" target="_top">Frames</a></li>
<li><a href="FragmentMessageResponsePacket.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 FragmentMessageResponsePacket" class="title">Class FragmentMessageResponsePacket</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.FragmentMessageResponsePacket</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">FragmentMessageResponsePacket</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 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>.
<p>
Major ID: 254
Minor ID: 4
</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">&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/FragmentMessageResponsePacket.html#FragmentMessageResponsePacket-java.lang.Integer-java.lang.Integer-byte:A-">FragmentMessageResponsePacket</a></span>(java.lang.Integer&nbsp;packetID,
java.lang.Integer&nbsp;fragmentID,
byte[]&nbsp;payload)</code>
<div class="block">Constructs a new FragmentMessageResponsePacket 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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><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/FragmentMessageResponsePacket.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/FragmentMessageResponsePacket.html#getTheProtocol--">getTheProtocol</a></span>()</code>
<div class="block">Gets the protocol information statically.</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&nbsp;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#isValid--">isValid</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html#loadPayload-byte:A-">loadPayload</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html#savePayload--">savePayload</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&nbsp;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&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="FragmentMessageResponsePacket-java.lang.Integer-java.lang.Integer-byte:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FragmentMessageResponsePacket</h4>
<pre>public&nbsp;FragmentMessageResponsePacket(java.lang.Integer&nbsp;packetID,
java.lang.Integer&nbsp;fragmentID,
byte[]&nbsp;payload)</pre>
<div class="block">Constructs a new FragmentMessageResponsePacket 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="getProtocol--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProtocol</h4>
<pre>public&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;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="blockListLast">
<li class="blockList">
<h4>getTheProtocol</h4>
<pre>public static&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;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>
</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/FragmentMessagePacket.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/FragmentPIDAKNPacket.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/FragmentMessageResponsePacket.html" target="_top">Frames</a></li>
<li><a href="FragmentMessageResponsePacket.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>

View File

@ -0,0 +1,398 @@
<!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>FragmentPIDAKNPacket</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="FragmentPIDAKNPacket";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":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/FragmentMessageResponsePacket.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/FragmentPIDMSGPacket.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/FragmentPIDAKNPacket.html" target="_top">Frames</a></li>
<li><a href="FragmentPIDAKNPacket.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 FragmentPIDAKNPacket" class="title">Class FragmentPIDAKNPacket</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>com.captainalm.lib.calmnet.packet.fragment.FragmentPIDAKNPacket</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/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentRetrySendPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentRetrySendPacket</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSendCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendCompletePacket</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">FragmentPIDAKNPacket</span>
extends <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDPacket</a>
implements <a href="../../../../../../com/captainalm/lib/calmnet/packet/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a></pre>
<div class="block">This abstract base class provides the ability for packets to contain an ID and if it is an Acknowledgement.</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/FragmentPIDAKNPacket.html#FragmentPIDAKNPacket-java.lang.Integer-java.lang.Boolean-">FragmentPIDAKNPacket</a></span>(java.lang.Integer&nbsp;packetID,
java.lang.Boolean&nbsp;acknowledgement)</code>
<div class="block">Constructs a new FragmentPIDPacket given the packet ID and the acknowledgement value.</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/FragmentPIDAKNPacket.html#isAcknowledgement--">isAcknowledgement</a></span>()</code>
<div class="block">Gets if the class instance is an Acknowledgement.</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/FragmentPIDAKNPacket.html#isValid--">isValid</a></span>()</code>
<div class="block">Gets if the packet is valid.</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/FragmentPIDAKNPacket.html#loadPayload-byte:A-">loadPayload</a></span>(byte[]&nbsp;packetData)</code>
<div class="block">Loads the packet payload from save data.</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/FragmentPIDAKNPacket.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.FragmentPIDPacket">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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&nbsp;java.lang.Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.captainalm.lib.calmnet.packet.IPacket">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;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></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="FragmentPIDAKNPacket-java.lang.Integer-java.lang.Boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FragmentPIDAKNPacket</h4>
<pre>public&nbsp;FragmentPIDAKNPacket(java.lang.Integer&nbsp;packetID,
java.lang.Boolean&nbsp;acknowledgement)</pre>
<div class="block">Constructs a new FragmentPIDPacket given the packet ID and the acknowledgement value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>packetID</code> - The packet ID.</dd>
<dd><code>acknowledgement</code> - The acknowledgement value to use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - packetID 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&nbsp;boolean&nbsp;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>&nbsp;in interface&nbsp;<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/FragmentPIDPacket.html#isValid--">isValid</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDPacket</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Is the packet valid?</dd>
</dl>
</li>
</ul>
<a name="savePayload--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>savePayload</h4>
<pre>public&nbsp;byte[]&nbsp;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>&nbsp;in interface&nbsp;<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="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>
<a name="loadPayload-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadPayload</h4>
<pre>public&nbsp;void&nbsp;loadPayload(byte[]&nbsp;packetData)
throws <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
<div class="block">Loads the packet payload from save data.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#loadPayload-byte:A-">loadPayload</a></code>&nbsp;in interface&nbsp;<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="paramLabel">Parameters:</span></dt>
<dd><code>packetData</code> - The packet payload data.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - The new store data is null.</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="isAcknowledgement--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isAcknowledgement</h4>
<pre>public&nbsp;boolean&nbsp;isAcknowledgement()</pre>
<div class="block">Gets if the class instance is an Acknowledgement.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IAcknowledgement.html#isAcknowledgement--">isAcknowledgement</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If the class instance is an Acknowledgement.</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/FragmentMessageResponsePacket.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/FragmentPIDMSGPacket.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/FragmentPIDAKNPacket.html" target="_top">Frames</a></li>
<li><a href="FragmentPIDAKNPacket.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>

View File

@ -0,0 +1,414 @@
<!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>FragmentPIDMSGPacket</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="FragmentPIDMSGPacket";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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/FragmentPIDAKNPacket.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/FragmentPIDPacket.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/FragmentPIDMSGPacket.html" target="_top">Frames</a></li>
<li><a href="FragmentPIDMSGPacket.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 FragmentPIDMSGPacket" class="title">Class FragmentPIDMSGPacket</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>com.captainalm.lib.calmnet.packet.fragment.FragmentPIDMSGPacket</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>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentMessagePacket</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentMessageResponsePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentMessageResponsePacket</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">FragmentPIDMSGPacket</span>
extends <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDPacket</a></pre>
<div class="block">This abstract base class provides the ability for packets to contain an ID, a Fragment ID and a payload.</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/FragmentPIDMSGPacket.html#FragmentPIDMSGPacket-java.lang.Integer-java.lang.Integer-byte:A-">FragmentPIDMSGPacket</a></span>(java.lang.Integer&nbsp;packetID,
java.lang.Integer&nbsp;fragmentID,
byte[]&nbsp;payload)</code>
<div class="block">Constructs a new FragmentPIDMSGPacket 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">&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>java.lang.Integer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html#getFragmentID--">getFragmentID</a></span>()</code>
<div class="block">Gets the fragment ID or null.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html#getFragmentMessage--">getFragmentMessage</a></span>()</code>
<div class="block">Gets the fragment message byte array or null.</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/FragmentPIDMSGPacket.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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html#loadPayload-byte:A-">loadPayload</a></span>(byte[]&nbsp;packetData)</code>
<div class="block">Loads the packet payload from save data.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.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.FragmentPIDPacket">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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&nbsp;java.lang.Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.captainalm.lib.calmnet.packet.IPacket">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;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></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="FragmentPIDMSGPacket-java.lang.Integer-java.lang.Integer-byte:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FragmentPIDMSGPacket</h4>
<pre>public&nbsp;FragmentPIDMSGPacket(java.lang.Integer&nbsp;packetID,
java.lang.Integer&nbsp;fragmentID,
byte[]&nbsp;payload)</pre>
<div class="block">Constructs a new FragmentPIDMSGPacket 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&nbsp;boolean&nbsp;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>&nbsp;in interface&nbsp;<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/FragmentPIDPacket.html#isValid--">isValid</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDPacket</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Is the packet valid?</dd>
</dl>
</li>
</ul>
<a name="savePayload--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>savePayload</h4>
<pre>public&nbsp;byte[]&nbsp;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="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>
<a name="loadPayload-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadPayload</h4>
<pre>public&nbsp;void&nbsp;loadPayload(byte[]&nbsp;packetData)
throws <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
<div class="block">Loads the packet payload from save data.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>packetData</code> - The packet payload data.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - The new store data is null.</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="getFragmentMessage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFragmentMessage</h4>
<pre>public&nbsp;byte[]&nbsp;getFragmentMessage()</pre>
<div class="block">Gets the fragment message byte array or null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The byte array or null.</dd>
</dl>
</li>
</ul>
<a name="getFragmentID--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getFragmentID</h4>
<pre>public&nbsp;java.lang.Integer&nbsp;getFragmentID()</pre>
<div class="block">Gets the fragment ID or null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The fragment ID or null.</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/FragmentPIDAKNPacket.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/FragmentPIDPacket.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/FragmentPIDMSGPacket.html" target="_top">Frames</a></li>
<li><a href="FragmentPIDMSGPacket.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>

View File

@ -0,0 +1,328 @@
<!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>FragmentPIDPacket</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="FragmentPIDPacket";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":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/FragmentPIDMSGPacket.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/FragmentReceiver.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/FragmentPIDPacket.html" target="_top">Frames</a></li>
<li><a href="FragmentPIDPacket.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 FragmentPIDPacket" class="title">Class FragmentPIDPacket</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.packet.fragment.FragmentPIDPacket</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>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentAllocationPacket</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDAKNPacket</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDMSGPacket</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSendStopPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendStopPacket</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSendVerifyCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendVerifyCompletePacket</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">FragmentPIDPacket</span>
extends java.lang.Object
implements <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></pre>
<div class="block">This abstract base class provides the ability for packets to return an ID.</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/FragmentPIDPacket.html#FragmentPIDPacket-java.lang.Integer-">FragmentPIDPacket</a></span>(java.lang.Integer&nbsp;packetID)</code>
<div class="block">Constructs a new FragmentPIDPacket given the packet ID.</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>java.lang.Integer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html#getPacketID--">getPacketID</a></span>()</code>
<div class="block">Gets the packet ID or null.</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/FragmentPIDPacket.html#isValid--">isValid</a></span>()</code>
<div class="block">Gets if the packet is valid.</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>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.captainalm.lib.calmnet.packet.IPacket">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;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#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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="FragmentPIDPacket-java.lang.Integer-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FragmentPIDPacket</h4>
<pre>public&nbsp;FragmentPIDPacket(java.lang.Integer&nbsp;packetID)</pre>
<div class="block">Constructs a new FragmentPIDPacket given the packet ID.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>packetID</code> - The packet ID.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - packetID 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&nbsp;boolean&nbsp;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>&nbsp;in interface&nbsp;<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="returnLabel">Returns:</span></dt>
<dd>Is the packet valid?</dd>
</dl>
</li>
</ul>
<a name="getPacketID--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPacketID</h4>
<pre>public&nbsp;java.lang.Integer&nbsp;getPacketID()</pre>
<div class="block">Gets the packet ID or null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The packet ID or null.</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/FragmentPIDMSGPacket.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/FragmentReceiver.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/FragmentPIDPacket.html" target="_top">Frames</a></li>
<li><a href="FragmentPIDPacket.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>

View File

@ -0,0 +1,772 @@
<!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>FragmentReceiver</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="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.</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 verified to be equal.</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 verified to be equal.</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.</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.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Should responses be verified.</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.
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.</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 verified to be equal.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If all sent fragments will be verified to be equal.</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 verified to be equal.
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 will be verified to be equal.</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>

View File

@ -0,0 +1,346 @@
<!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>FragmentRetrySendPacket</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="FragmentRetrySendPacket";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9};
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/FragmentReceiver.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/FragmentSendCompletePacket.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/FragmentRetrySendPacket.html" target="_top">Frames</a></li>
<li><a href="FragmentRetrySendPacket.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 FragmentRetrySendPacket" class="title">Class FragmentRetrySendPacket</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/FragmentPIDAKNPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">com.captainalm.lib.calmnet.packet.fragment.FragmentPIDAKNPacket</a></li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.packet.fragment.FragmentRetrySendPacket</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/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a>, <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">FragmentRetrySendPacket</span>
extends <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDAKNPacket</a></pre>
<div class="block">This class provides a packet for signalling that the sending end
should start re-sending un acknowledged fragment packets.
<p>
Major ID: 254
Minor ID: 6
</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">&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/FragmentRetrySendPacket.html#FragmentRetrySendPacket-java.lang.Integer-java.lang.Boolean-">FragmentRetrySendPacket</a></span>(java.lang.Integer&nbsp;packetID,
java.lang.Boolean&nbsp;acknowledgement)</code>
<div class="block">Constructs a new FragmentRetrySendPacket given the packet ID and the acknowledgement value.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><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/FragmentRetrySendPacket.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/FragmentRetrySendPacket.html#getTheProtocol--">getTheProtocol</a></span>()</code>
<div class="block">Gets the protocol information statically.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.captainalm.lib.calmnet.packet.fragment.FragmentPIDAKNPacket">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.captainalm.lib.calmnet.packet.fragment.<a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDAKNPacket</a></h3>
<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html#isAcknowledgement--">isAcknowledgement</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html#isValid--">isValid</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html#loadPayload-byte:A-">loadPayload</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html#savePayload--">savePayload</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&nbsp;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&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="FragmentRetrySendPacket-java.lang.Integer-java.lang.Boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FragmentRetrySendPacket</h4>
<pre>public&nbsp;FragmentRetrySendPacket(java.lang.Integer&nbsp;packetID,
java.lang.Boolean&nbsp;acknowledgement)</pre>
<div class="block">Constructs a new FragmentRetrySendPacket given the packet ID and the acknowledgement value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>packetID</code> - The packet ID.</dd>
<dd><code>acknowledgement</code> - The acknowledgement value to use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - packetID 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="getProtocol--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProtocol</h4>
<pre>public&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;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="blockListLast">
<li class="blockList">
<h4>getTheProtocol</h4>
<pre>public static&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;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>
</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/FragmentReceiver.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/FragmentSendCompletePacket.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/FragmentRetrySendPacket.html" target="_top">Frames</a></li>
<li><a href="FragmentRetrySendPacket.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>

View File

@ -0,0 +1,345 @@
<!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>FragmentSendCompletePacket</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="FragmentSendCompletePacket";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9};
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/FragmentRetrySendPacket.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/FragmentSender.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/FragmentSendCompletePacket.html" target="_top">Frames</a></li>
<li><a href="FragmentSendCompletePacket.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 FragmentSendCompletePacket" class="title">Class FragmentSendCompletePacket</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/FragmentPIDAKNPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">com.captainalm.lib.calmnet.packet.fragment.FragmentPIDAKNPacket</a></li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.packet.fragment.FragmentSendCompletePacket</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/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a>, <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">FragmentSendCompletePacket</span>
extends <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDAKNPacket</a></pre>
<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.
<p>
Major ID: 254
Minor ID: 5
</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">&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/FragmentSendCompletePacket.html#FragmentSendCompletePacket-java.lang.Integer-java.lang.Boolean-">FragmentSendCompletePacket</a></span>(java.lang.Integer&nbsp;packetID,
java.lang.Boolean&nbsp;acknowledgement)</code>
<div class="block">Constructs a new FragmentSendCompletePacket given the packet ID and the acknowledgement value.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><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/FragmentSendCompletePacket.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/FragmentSendCompletePacket.html#getTheProtocol--">getTheProtocol</a></span>()</code>
<div class="block">Gets the protocol information statically.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.captainalm.lib.calmnet.packet.fragment.FragmentPIDAKNPacket">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.captainalm.lib.calmnet.packet.fragment.<a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDAKNPacket</a></h3>
<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html#isAcknowledgement--">isAcknowledgement</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html#isValid--">isValid</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html#loadPayload-byte:A-">loadPayload</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html#savePayload--">savePayload</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&nbsp;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&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="FragmentSendCompletePacket-java.lang.Integer-java.lang.Boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FragmentSendCompletePacket</h4>
<pre>public&nbsp;FragmentSendCompletePacket(java.lang.Integer&nbsp;packetID,
java.lang.Boolean&nbsp;acknowledgement)</pre>
<div class="block">Constructs a new FragmentSendCompletePacket given the packet ID and the acknowledgement value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>packetID</code> - The packet ID.</dd>
<dd><code>acknowledgement</code> - The acknowledgement value to use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - packetID 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="getProtocol--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProtocol</h4>
<pre>public&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;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="blockListLast">
<li class="blockList">
<h4>getTheProtocol</h4>
<pre>public static&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;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>
</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/FragmentRetrySendPacket.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/FragmentSender.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/FragmentSendCompletePacket.html" target="_top">Frames</a></li>
<li><a href="FragmentSendCompletePacket.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>

View File

@ -0,0 +1,377 @@
<!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>FragmentSendStopPacket</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="FragmentSendStopPacket";
}
}
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/FragmentSender.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/FragmentSendVerifyCompletePacket.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/FragmentSendStopPacket.html" target="_top">Frames</a></li>
<li><a href="FragmentSendStopPacket.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 FragmentSendStopPacket" class="title">Class FragmentSendStopPacket</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>com.captainalm.lib.calmnet.packet.fragment.FragmentSendStopPacket</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">FragmentSendStopPacket</span>
extends <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDPacket</a></pre>
<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>.
<p>
Major ID: 254
Minor ID: 7
</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">&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/FragmentSendStopPacket.html#FragmentSendStopPacket-java.lang.Integer-">FragmentSendStopPacket</a></span>(java.lang.Integer&nbsp;packetID)</code>
<div class="block">Constructs a new FragmentSendStopPacket given the packet ID.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><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/FragmentSendStopPacket.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/FragmentSendStopPacket.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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSendStopPacket.html#loadPayload-byte:A-">loadPayload</a></span>(byte[]&nbsp;packetData)</code>
<div class="block">Loads the packet payload from save data.</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/FragmentSendStopPacket.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.FragmentPIDPacket">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html#isValid--">isValid</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&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="FragmentSendStopPacket-java.lang.Integer-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FragmentSendStopPacket</h4>
<pre>public&nbsp;FragmentSendStopPacket(java.lang.Integer&nbsp;packetID)</pre>
<div class="block">Constructs a new FragmentSendStopPacket given the packet ID.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>packetID</code> - The packet ID.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - packetID 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="getProtocol--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProtocol</h4>
<pre>public&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;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&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;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="blockList">
<li class="blockList">
<h4>savePayload</h4>
<pre>public&nbsp;byte[]&nbsp;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="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>
<a name="loadPayload-byte:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>loadPayload</h4>
<pre>public&nbsp;void&nbsp;loadPayload(byte[]&nbsp;packetData)
throws <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
<div class="block">Loads the packet payload from save data.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>packetData</code> - The packet payload data.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - The new store data is null.</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>
</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/FragmentSender.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/FragmentSendVerifyCompletePacket.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/FragmentSendStopPacket.html" target="_top">Frames</a></li>
<li><a href="FragmentSendStopPacket.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>

View File

@ -0,0 +1,377 @@
<!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>FragmentSendVerifyCompletePacket</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="FragmentSendVerifyCompletePacket";
}
}
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/FragmentSendStopPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/fragment/FragmentSendVerifyCompletePacket.html" target="_top">Frames</a></li>
<li><a href="FragmentSendVerifyCompletePacket.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 FragmentSendVerifyCompletePacket" class="title">Class FragmentSendVerifyCompletePacket</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>com.captainalm.lib.calmnet.packet.fragment.FragmentSendVerifyCompletePacket</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">FragmentSendVerifyCompletePacket</span>
extends <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDPacket</a></pre>
<div class="block">This class provides a packet for stating that all packets have been successfully sent and verified.
<p>
Major ID: 254
Minor ID: 8
</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">&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/FragmentSendVerifyCompletePacket.html#FragmentSendVerifyCompletePacket-java.lang.Integer-">FragmentSendVerifyCompletePacket</a></span>(java.lang.Integer&nbsp;packetID)</code>
<div class="block">Constructs a new FragmentSendVerifyCompletePacket given the packet ID.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><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/FragmentSendVerifyCompletePacket.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/FragmentSendVerifyCompletePacket.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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSendVerifyCompletePacket.html#loadPayload-byte:A-">loadPayload</a></span>(byte[]&nbsp;packetData)</code>
<div class="block">Loads the packet payload from save data.</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/FragmentSendVerifyCompletePacket.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.FragmentPIDPacket">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html#isValid--">isValid</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&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="FragmentSendVerifyCompletePacket-java.lang.Integer-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FragmentSendVerifyCompletePacket</h4>
<pre>public&nbsp;FragmentSendVerifyCompletePacket(java.lang.Integer&nbsp;packetID)</pre>
<div class="block">Constructs a new FragmentSendVerifyCompletePacket given the packet ID.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>packetID</code> - The packet ID.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - packetID 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="getProtocol--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProtocol</h4>
<pre>public&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;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&nbsp;<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a>&nbsp;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="blockList">
<li class="blockList">
<h4>savePayload</h4>
<pre>public&nbsp;byte[]&nbsp;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="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>
<a name="loadPayload-byte:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>loadPayload</h4>
<pre>public&nbsp;void&nbsp;loadPayload(byte[]&nbsp;packetData)
throws <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
<div class="block">Loads the packet payload from save data.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>packetData</code> - The packet payload data.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - The new store data is null.</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>
</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/FragmentSendStopPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/fragment/FragmentSendVerifyCompletePacket.html" target="_top">Frames</a></li>
<li><a href="FragmentSendVerifyCompletePacket.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>

View File

@ -0,0 +1,720 @@
<!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>FragmentSender</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="FragmentSender";
}
}
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};
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/FragmentSendCompletePacket.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/FragmentSendStopPacket.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/FragmentSender.html" target="_top">Frames</a></li>
<li><a href="FragmentSender.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 FragmentSender" class="title">Class FragmentSender</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.packet.fragment.FragmentSender</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">FragmentSender</span>
extends java.lang.Object</pre>
<div class="block">This class provides the ability to create packets for <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/FragmentSender.html#FragmentSender-com.captainalm.lib.calmnet.packet.PacketLoader-">FragmentSender</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">Constructs a new FragmentSender with the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#FragmentSender-com.captainalm.lib.calmnet.packet.PacketLoader-int-">FragmentSender</a></span>(<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a>&nbsp;loader,
int&nbsp;newSize)</code>
<div class="block">Constructs a new FragmentSender 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 packet split size in bytes.</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/FragmentSender.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/FragmentSender.html#arePacketsWaiting--">arePacketsWaiting</a></span>()</code>
<div class="block">Gets whether packets are waiting for allocation.</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/FragmentSender.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/FragmentSender.html#clearRegistry--">clearRegistry</a></span>()</code>
<div class="block">Clears the registry.</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/FragmentSender.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/FragmentSender.html#deletePacketFromRegistry-int-">deletePacketFromRegistry</a></span>(int&nbsp;id)</code>
<div class="block">Deletes a packet from the registry.</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/FragmentSender.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><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/FragmentSender.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="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#getSplitSize--">getSplitSize</a></span>()</code>
<div class="block">Gets the current packet split size in bytes.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.Integer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#pollLastIDFinished--">pollLastIDFinished</a></span>()</code>
<div class="block">Polls the last finished packet ID.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.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 FragmentSender.</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/FragmentSender.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 FragmentSender.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#sendPacket-com.captainalm.lib.calmnet.packet.IPacket-">sendPacket</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">Sends a <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> using this FragmentSender.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.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="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#setResponseVerification-boolean-">setResponseVerification</a></span>(boolean&nbsp;state)</code>
<div class="block">Sets whether responses should be verified.</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/FragmentSender.html#setSentDataWillBeAllVerified-boolean-">setSentDataWillBeAllVerified</a></span>(boolean&nbsp;state)</code>
<div class="block">Gets whether all sent fragments are verified to be equal.</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/FragmentSender.html#setSplitSize-int-">setSplitSize</a></span>(int&nbsp;newSize)</code>
<div class="block">Sets the packet split size in bytes.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#shouldSentDataBeAllVerified--">shouldSentDataBeAllVerified</a></span>()</code>
<div class="block">Gets whether all sent fragments are verified to be equal.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#shouldVerifyResponses--">shouldVerifyResponses</a></span>()</code>
<div class="block">Gets whether responses should 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/FragmentSender.html#stopAllDataVerificationAndCompleteSend--">stopAllDataVerificationAndCompleteSend</a></span>()</code>
<div class="block">Stops data verification for all packets being sent when <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#shouldSentDataBeAllVerified--"><code>shouldSentDataBeAllVerified()</code></a> is true.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#stopDataVerificationAndCompleteSend-int-">stopDataVerificationAndCompleteSend</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/FragmentSender.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="FragmentSender-com.captainalm.lib.calmnet.packet.PacketLoader-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FragmentSender</h4>
<pre>public&nbsp;FragmentSender(<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">Constructs a new FragmentSender with the specified <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>.</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="FragmentSender-com.captainalm.lib.calmnet.packet.PacketLoader-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FragmentSender</h4>
<pre>public&nbsp;FragmentSender(<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a>&nbsp;loader,
int&nbsp;newSize)</pre>
<div class="block">Constructs a new FragmentSender 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 packet split size in bytes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>loader</code> - The packet loader to use.</dd>
<dd><code>newSize</code> - The new split size.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - loader is null.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - newSize is less than 1.</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="sendPacket-com.captainalm.lib.calmnet.packet.IPacket-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendPacket</h4>
<pre>public&nbsp;void&nbsp;sendPacket(<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>&nbsp;packetIn)</pre>
<div class="block">Sends a <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> using this FragmentSender.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>packetIn</code> - The packet to fragment and send.</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 FragmentSender.</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 FragmentSender.</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 for allocation.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If packets are waiting for allocation.</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.</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.
NOTE: Do NOT do this unless you are finished with the FragmentSender.</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="getSplitSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSplitSize</h4>
<pre>public&nbsp;int&nbsp;getSplitSize()</pre>
<div class="block">Gets the current packet split size in bytes.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The current packet split size.</dd>
</dl>
</li>
</ul>
<a name="setSplitSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSplitSize</h4>
<pre>public&nbsp;void&nbsp;setSplitSize(int&nbsp;newSize)</pre>
<div class="block">Sets the packet split size in bytes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newSize</code> - The new packet split size.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - newSize is less than 1.</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.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Should responses be verified.</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.
If set to false, <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.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.</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 verified to be equal.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If all sent fragments will be verified to be equal.</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 verified to be equal.
Requires <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.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 will be verified to be equal.</dd>
</dl>
</li>
</ul>
<a name="stopDataVerificationAndCompleteSend-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopDataVerificationAndCompleteSend</h4>
<pre>public&nbsp;void&nbsp;stopDataVerificationAndCompleteSend(int&nbsp;id)</pre>
<div class="block">Stops data verification for the specified Packet ID when <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.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="stopAllDataVerificationAndCompleteSend--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>stopAllDataVerificationAndCompleteSend</h4>
<pre>public&nbsp;void&nbsp;stopAllDataVerificationAndCompleteSend()</pre>
<div class="block">Stops data verification for all packets being sent when <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.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/FragmentSendCompletePacket.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/FragmentSendStopPacket.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/FragmentSender.html" target="_top">Frames</a></li>
<li><a href="FragmentSender.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>

View File

@ -0,0 +1,32 @@
<!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:22 BST 2023 -->
<title>com.captainalm.lib.calmnet.packet.fragment</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>
<h1 class="bar"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/package-summary.html" target="classFrame">com.captainalm.lib.calmnet.packet.fragment</a></h1>
<div class="indexContainer">
<h2 title="Classes">Classes</h2>
<ul title="Classes">
<li><a href="FragmentAllocatePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentAllocatePacket</a></li>
<li><a href="FragmentAllocationPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentAllocationPacket</a></li>
<li><a href="FragmentMessagePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentMessagePacket</a></li>
<li><a href="FragmentMessageResponsePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentMessageResponsePacket</a></li>
<li><a href="FragmentPIDAKNPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentPIDAKNPacket</a></li>
<li><a href="FragmentPIDMSGPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentPIDMSGPacket</a></li>
<li><a href="FragmentPIDPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentPIDPacket</a></li>
<li><a href="FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentReceiver</a></li>
<li><a href="FragmentRetrySendPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentRetrySendPacket</a></li>
<li><a href="FragmentSendCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentSendCompletePacket</a></li>
<li><a href="FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentSender</a></li>
<li><a href="FragmentSendStopPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentSendStopPacket</a></li>
<li><a href="FragmentSendVerifyCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment" target="classFrame">FragmentSendVerifyCompletePacket</a></li>
</ul>
</div>
</body>
</html>

View File

@ -0,0 +1,235 @@
<!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:22 BST 2023 -->
<title>com.captainalm.lib.calmnet.packet.fragment</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="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>

View File

@ -0,0 +1,156 @@
<!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:22 BST 2023 -->
<title>com.captainalm.lib.calmnet.packet.fragment Class Hierarchy</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="com.captainalm.lib.calmnet.packet.fragment Class Hierarchy";
}
}
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><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</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-tree.html">Prev</a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/ssl/package-tree.html">Next</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/fragment/package-tree.html" target="_top">Frames</a></li>
<li><a href="package-tree.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 class="title">Hierarchy For Package com.captainalm.lib.calmnet.packet.fragment</h1>
<span class="packageHierarchyLabel">Package Hierarchies:</span>
<ul class="horizontal">
<li><a href="../../../../../../overview-tree.html">All Packages</a></li>
</ul>
</div>
<div class="contentContainer">
<h2 title="Class Hierarchy">Class Hierarchy</h2>
<ul>
<li type="circle">java.lang.Object
<ul>
<li type="circle">com.captainalm.lib.calmnet.packet.fragment.<a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentAllocatePacket</span></a> (implements com.captainalm.lib.calmnet.packet.<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>)</li>
<li type="circle">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"><span class="typeNameLink">FragmentPIDPacket</span></a> (implements com.captainalm.lib.calmnet.packet.<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>)
<ul>
<li type="circle">com.captainalm.lib.calmnet.packet.fragment.<a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentAllocationPacket</span></a></li>
<li type="circle">com.captainalm.lib.calmnet.packet.fragment.<a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentPIDAKNPacket</span></a> (implements com.captainalm.lib.calmnet.packet.<a href="../../../../../../com/captainalm/lib/calmnet/packet/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a>)
<ul>
<li type="circle">com.captainalm.lib.calmnet.packet.fragment.<a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentRetrySendPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentRetrySendPacket</span></a></li>
<li type="circle">com.captainalm.lib.calmnet.packet.fragment.<a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSendCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentSendCompletePacket</span></a></li>
</ul>
</li>
<li type="circle">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"><span class="typeNameLink">FragmentPIDMSGPacket</span></a>
<ul>
<li type="circle">com.captainalm.lib.calmnet.packet.fragment.<a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentMessagePacket</span></a></li>
<li type="circle">com.captainalm.lib.calmnet.packet.fragment.<a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentMessageResponsePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentMessageResponsePacket</span></a></li>
</ul>
</li>
<li type="circle">com.captainalm.lib.calmnet.packet.fragment.<a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSendStopPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentSendStopPacket</span></a></li>
<li type="circle">com.captainalm.lib.calmnet.packet.fragment.<a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSendVerifyCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentSendVerifyCompletePacket</span></a></li>
</ul>
</li>
<li type="circle">com.captainalm.lib.calmnet.packet.fragment.<a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentReceiver</span></a></li>
<li type="circle">com.captainalm.lib.calmnet.packet.fragment.<a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentSender</span></a></li>
</ul>
</li>
</ul>
</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><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</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-tree.html">Prev</a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/ssl/package-tree.html">Next</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/fragment/package-tree.html" target="_top">Frames</a></li>
<li><a href="package-tree.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>

View File

@ -0,0 +1,32 @@
<!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:22 BST 2023 -->
<title>com.captainalm.lib.calmnet.packet</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>
<h1 class="bar"><a href="../../../../../com/captainalm/lib/calmnet/packet/package-summary.html" target="classFrame">com.captainalm.lib.calmnet.packet</a></h1>
<div class="indexContainer">
<h2 title="Interfaces">Interfaces</h2>
<ul title="Interfaces">
<li><a href="IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet" target="classFrame"><span class="interfaceName">IAcknowledgement</span></a></li>
<li><a href="IInternalCache.html" title="interface in com.captainalm.lib.calmnet.packet" target="classFrame"><span class="interfaceName">IInternalCache</span></a></li>
<li><a href="IPacket.html" title="interface in com.captainalm.lib.calmnet.packet" target="classFrame"><span class="interfaceName">IPacket</span></a></li>
<li><a href="IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet" target="classFrame"><span class="interfaceName">IStreamedPacket</span></a></li>
</ul>
<h2 title="Classes">Classes</h2>
<ul title="Classes">
<li><a href="PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet" target="classFrame">PacketLoader</a></li>
<li><a href="PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet" target="classFrame">PacketProtocolInformation</a></li>
</ul>
<h2 title="Exceptions">Exceptions</h2>
<ul title="Exceptions">
<li><a href="PacketException.html" title="class in com.captainalm.lib.calmnet.packet" target="classFrame">PacketException</a></li>
</ul>
</div>
</body>
</html>

View File

@ -0,0 +1,215 @@
<!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:22 BST 2023 -->
<title>com.captainalm.lib.calmnet.packet</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="com.captainalm.lib.calmnet.packet";
}
}
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/marshal/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/packet/core/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/packet/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</h1>
<div class="docSummary">
<div class="block">This package contains the network packets and handling code.</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="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/captainalm/lib/calmnet/packet/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a></td>
<td class="colLast">
<div class="block">This interface allows obtaining if the class instance is an Acknowledgement.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/captainalm/lib/calmnet/packet/IInternalCache.html" title="interface in com.captainalm.lib.calmnet.packet">IInternalCache</a></td>
<td class="colLast">
<div class="block">This interface allows getting and setting if the
internal cache should be used within a class instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></td>
<td class="colLast">
<div class="block">This interface provides the packet methods.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</a></td>
<td class="colLast">
<div class="block">This interface provides the streaming packet methods.</div>
</td>
</tr>
</tbody>
</table>
</li>
<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/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a></td>
<td class="colLast">
<div class="block">This class provides the ability to load and save <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>
to <code>InputStream</code> and <code>OutputStream</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a></td>
<td class="colLast">
<div class="block">This class provides the packet protocol information for <a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></td>
<td class="colLast">
<div class="block">This class provides the packet exception wrapper class.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package com.captainalm.lib.calmnet.packet Description">Package com.captainalm.lib.calmnet.packet Description</h2>
<div class="block">This package contains the network packets and handling code.</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/marshal/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/packet/core/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/packet/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>

View File

@ -0,0 +1,155 @@
<!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:22 BST 2023 -->
<title>com.captainalm.lib.calmnet.packet Class Hierarchy</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="com.captainalm.lib.calmnet.packet Class Hierarchy";
}
}
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><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</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/marshal/package-tree.html">Prev</a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/packet/core/package-tree.html">Next</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/packet/package-tree.html" target="_top">Frames</a></li>
<li><a href="package-tree.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 class="title">Hierarchy For Package com.captainalm.lib.calmnet.packet</h1>
<span class="packageHierarchyLabel">Package Hierarchies:</span>
<ul class="horizontal">
<li><a href="../../../../../overview-tree.html">All Packages</a></li>
</ul>
</div>
<div class="contentContainer">
<h2 title="Class Hierarchy">Class Hierarchy</h2>
<ul>
<li type="circle">java.lang.Object
<ul>
<li type="circle">com.captainalm.lib.calmnet.packet.<a href="../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">PacketLoader</span></a></li>
<li type="circle">com.captainalm.lib.calmnet.packet.<a href="../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">PacketProtocolInformation</span></a></li>
<li type="circle">java.lang.Throwable (implements java.io.Serializable)
<ul>
<li type="circle">java.lang.Exception
<ul>
<li type="circle">com.captainalm.lib.calmnet.packet.<a href="../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">PacketException</span></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h2 title="Interface Hierarchy">Interface Hierarchy</h2>
<ul>
<li type="circle">com.captainalm.lib.calmnet.packet.<a href="../../../../../com/captainalm/lib/calmnet/packet/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">IAcknowledgement</span></a></li>
<li type="circle">com.captainalm.lib.calmnet.packet.<a href="../../../../../com/captainalm/lib/calmnet/packet/IInternalCache.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">IInternalCache</span></a></li>
<li type="circle">com.captainalm.lib.calmnet.packet.<a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">IPacket</span></a>
<ul>
<li type="circle">com.captainalm.lib.calmnet.packet.<a href="../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">IStreamedPacket</span></a></li>
</ul>
</li>
</ul>
</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><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</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/marshal/package-tree.html">Prev</a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/packet/core/package-tree.html">Next</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/packet/package-tree.html" target="_top">Frames</a></li>
<li><a href="package-tree.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>

View File

@ -0,0 +1,571 @@
<!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>SSLUtilities</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="SSLUtilities";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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>Prev&nbsp;Class</li>
<li><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/ssl/SSLUtilities.html" target="_top">Frames</a></li>
<li><a href="SSLUtilities.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.ssl</div>
<h2 title="Class SSLUtilities" class="title">Class SSLUtilities</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.ssl.SSLUtilities</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">SSLUtilities</span>
extends java.lang.Object</pre>
<div class="block">This class provides SSL utilities to create <code>SSLContext</code> and <code>SSLSocket</code>
objects using JKS files (Or other supported formats).</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/ssl/SSLUtilities.html#SSLUtilities--">SSLUtilities</a></span>()</code>&nbsp;</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>static javax.net.ssl.SSLSocket</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#getSSLClientSocket-javax.net.ssl.SSLContext-java.lang.String-int-">getSSLClientSocket</a></span>(javax.net.ssl.SSLContext&nbsp;sslContext,
java.lang.String&nbsp;host,
int&nbsp;port)</code>
<div class="block">Creates a new <code>SSLSocket</code> using the specified <code>SSLContext</code>, host and port.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static javax.net.ssl.SSLContext</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#getSSLContext-java.lang.String-java.security.KeyStore-char:A-">getSSLContext</a></span>(java.lang.String&nbsp;algorithmName,
java.security.KeyStore&nbsp;unifiedKeyStore,
char[]&nbsp;keyStorePassword)</code>
<div class="block">Gets the SSL context merged with the JRE Trust Store using a unified <code>KeyStore</code>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static javax.net.ssl.SSLContext</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#getSSLContext-java.lang.String-java.security.KeyStore-char:A-java.security.KeyStore-">getSSLContext</a></span>(java.lang.String&nbsp;algorithmName,
java.security.KeyStore&nbsp;privateKeyStore,
char[]&nbsp;privateKeyStorePassword,
java.security.KeyStore&nbsp;trustKeyStore)</code>
<div class="block">Gets the SSL context merged with the JRE Trust Store using separate private and trust <code>KeyStore</code>s.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static javax.net.ssl.SSLContext</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#getSSLContextNoJRETrust-java.lang.String-java.security.KeyStore-char:A-">getSSLContextNoJRETrust</a></span>(java.lang.String&nbsp;algorithmName,
java.security.KeyStore&nbsp;unifiedKeyStore,
char[]&nbsp;keyStorePassword)</code>
<div class="block">Gets the SSL context without the JRE Trust Store using a unified <code>KeyStore</code>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static javax.net.ssl.SSLContext</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#getSSLContextNoJRETrust-java.lang.String-java.security.KeyStore-char:A-java.security.KeyStore-">getSSLContextNoJRETrust</a></span>(java.lang.String&nbsp;algorithmName,
java.security.KeyStore&nbsp;privateKeyStore,
char[]&nbsp;privateKeyStorePassword,
java.security.KeyStore&nbsp;trustKeyStore)</code>
<div class="block">Gets the SSL context without the JRE Trust Store using separate private and trust <code>KeyStore</code>s.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static javax.net.ssl.SSLServerSocket</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#getSSLServerSocket-javax.net.ssl.SSLContext-int-int-java.net.InetAddress-">getSSLServerSocket</a></span>(javax.net.ssl.SSLContext&nbsp;sslContext,
int&nbsp;port,
int&nbsp;backlog,
java.net.InetAddress&nbsp;ifAddress)</code>
<div class="block">Gets the SSL Server socket for the specified <code>SSLContext</code>, port, backlog and <code>InetAddress</code>.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static java.security.KeyStore</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#loadKeyStore-java.lang.String-java.io.File-java.lang.String-">loadKeyStore</a></span>(java.lang.String&nbsp;type,
java.io.File&nbsp;file,
java.lang.String&nbsp;password)</code>
<div class="block">Loads a Keystore of a certain type from a file given the password.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static javax.net.ssl.SSLSocket</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#upgradeClientSocketToSSL-javax.net.ssl.SSLContext-java.net.Socket-java.lang.String-int-boolean-">upgradeClientSocketToSSL</a></span>(javax.net.ssl.SSLContext&nbsp;sslContext,
java.net.Socket&nbsp;socket,
java.lang.String&nbsp;host,
int&nbsp;port,
boolean&nbsp;autoClose)</code>
<div class="block">Upgrades an existing <code>Socket</code> to an <code>SSLSocket</code> using the specified <code>SSLContext</code>,
<code>Socket</code>, host, port and if the specified socket should be closed when the returned socket is closed.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static javax.net.ssl.SSLSocket</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#upgradeClientSocketToSSL-javax.net.ssl.SSLContext-java.net.Socket-java.lang.String-int-boolean-boolean-">upgradeClientSocketToSSL</a></span>(javax.net.ssl.SSLContext&nbsp;sslContext,
java.net.Socket&nbsp;socket,
java.lang.String&nbsp;host,
int&nbsp;port,
boolean&nbsp;autoClose,
boolean&nbsp;onClient)</code>
<div class="block">Upgrades an existing <code>Socket</code> to an <code>SSLSocket</code> using the specified <code>SSLContext</code>,
<code>Socket</code>, host, port and if the specified socket should be closed when the returned socket is closed.</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="SSLUtilities--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SSLUtilities</h4>
<pre>public&nbsp;SSLUtilities()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="loadKeyStore-java.lang.String-java.io.File-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadKeyStore</h4>
<pre>public static&nbsp;java.security.KeyStore&nbsp;loadKeyStore(java.lang.String&nbsp;type,
java.io.File&nbsp;file,
java.lang.String&nbsp;password)
throws <a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></pre>
<div class="block">Loads a Keystore of a certain type from a file given the password.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - The type of keystore (pass null for the default type).</dd>
<dd><code>file</code> - The file to load the keystore from.</dd>
<dd><code>password</code> - The password of the keystore (Can be null).</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The keystore.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - file is null.</dd>
<dd><code><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></code> - An Exception has occurred.</dd>
</dl>
</li>
</ul>
<a name="getSSLContextNoJRETrust-java.lang.String-java.security.KeyStore-char:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSSLContextNoJRETrust</h4>
<pre>public static&nbsp;javax.net.ssl.SSLContext&nbsp;getSSLContextNoJRETrust(java.lang.String&nbsp;algorithmName,
java.security.KeyStore&nbsp;unifiedKeyStore,
char[]&nbsp;keyStorePassword)
throws <a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></pre>
<div class="block">Gets the SSL context without the JRE Trust Store using a unified <code>KeyStore</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>algorithmName</code> - The name of the context protocol or null for the JRE Default (TLSv1).</dd>
<dd><code>unifiedKeyStore</code> - The keystore for use with the private and trust stores.</dd>
<dd><code>keyStorePassword</code> - The password of the key store or null (Use "changeit" for JKS keystore defaults).</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The SSLContext.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></code> - An Exception has occurred.</dd>
</dl>
</li>
</ul>
<a name="getSSLContextNoJRETrust-java.lang.String-java.security.KeyStore-char:A-java.security.KeyStore-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSSLContextNoJRETrust</h4>
<pre>public static&nbsp;javax.net.ssl.SSLContext&nbsp;getSSLContextNoJRETrust(java.lang.String&nbsp;algorithmName,
java.security.KeyStore&nbsp;privateKeyStore,
char[]&nbsp;privateKeyStorePassword,
java.security.KeyStore&nbsp;trustKeyStore)
throws <a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></pre>
<div class="block">Gets the SSL context without the JRE Trust Store using separate private and trust <code>KeyStore</code>s.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>algorithmName</code> - The name of the context protocol or null for the JRE Default (TLSv1).</dd>
<dd><code>privateKeyStore</code> - The keystore for use with the private store.</dd>
<dd><code>privateKeyStorePassword</code> - The password of the private key store or null (Use "changeit" for JKS keystore defaults).</dd>
<dd><code>trustKeyStore</code> - The keystore for use with the trust store.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The SSLContext.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></code> - An Exception has occurred.</dd>
</dl>
</li>
</ul>
<a name="getSSLContext-java.lang.String-java.security.KeyStore-char:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSSLContext</h4>
<pre>public static&nbsp;javax.net.ssl.SSLContext&nbsp;getSSLContext(java.lang.String&nbsp;algorithmName,
java.security.KeyStore&nbsp;unifiedKeyStore,
char[]&nbsp;keyStorePassword)
throws <a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></pre>
<div class="block">Gets the SSL context merged with the JRE Trust Store using a unified <code>KeyStore</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>algorithmName</code> - The name of the context protocol or null for the JRE Default (TLSv1).</dd>
<dd><code>unifiedKeyStore</code> - The keystore for use with the private and trust stores.</dd>
<dd><code>keyStorePassword</code> - The password of the key store or null (Use "changeit" for JKS keystore defaults).</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The SSLContext.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></code> - An Exception has occurred.</dd>
</dl>
</li>
</ul>
<a name="getSSLContext-java.lang.String-java.security.KeyStore-char:A-java.security.KeyStore-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSSLContext</h4>
<pre>public static&nbsp;javax.net.ssl.SSLContext&nbsp;getSSLContext(java.lang.String&nbsp;algorithmName,
java.security.KeyStore&nbsp;privateKeyStore,
char[]&nbsp;privateKeyStorePassword,
java.security.KeyStore&nbsp;trustKeyStore)
throws <a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></pre>
<div class="block">Gets the SSL context merged with the JRE Trust Store using separate private and trust <code>KeyStore</code>s.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>algorithmName</code> - The name of the context protocol or null for the JRE Default (TLSv1).</dd>
<dd><code>privateKeyStore</code> - The keystore for use with the private store.</dd>
<dd><code>privateKeyStorePassword</code> - The password of the private key store or null (Use "changeit" for JKS keystore defaults).</dd>
<dd><code>trustKeyStore</code> - The keystore for use with the trust store.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The SSLContext.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></code> - An Exception has occurred.</dd>
</dl>
</li>
</ul>
<a name="getSSLClientSocket-javax.net.ssl.SSLContext-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSSLClientSocket</h4>
<pre>public static&nbsp;javax.net.ssl.SSLSocket&nbsp;getSSLClientSocket(javax.net.ssl.SSLContext&nbsp;sslContext,
java.lang.String&nbsp;host,
int&nbsp;port)
throws <a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></pre>
<div class="block">Creates a new <code>SSLSocket</code> using the specified <code>SSLContext</code>, host and port.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sslContext</code> - The SSL Context to create the socket from.</dd>
<dd><code>host</code> - The host to connect to.</dd>
<dd><code>port</code> - The port to connect to.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The SSLSocket.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></code> - An Exception has occurred.</dd>
</dl>
</li>
</ul>
<a name="upgradeClientSocketToSSL-javax.net.ssl.SSLContext-java.net.Socket-java.lang.String-int-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>upgradeClientSocketToSSL</h4>
<pre>public static&nbsp;javax.net.ssl.SSLSocket&nbsp;upgradeClientSocketToSSL(javax.net.ssl.SSLContext&nbsp;sslContext,
java.net.Socket&nbsp;socket,
java.lang.String&nbsp;host,
int&nbsp;port,
boolean&nbsp;autoClose)
throws <a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></pre>
<div class="block">Upgrades an existing <code>Socket</code> to an <code>SSLSocket</code> using the specified <code>SSLContext</code>,
<code>Socket</code>, host, port and if the specified socket should be closed when the returned socket is closed.
This socket is in client mode (Upgrade for client side).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sslContext</code> - The SSL Context to create the socket from.</dd>
<dd><code>socket</code> - The socket to wrap.</dd>
<dd><code>host</code> - The host to "connect" to.</dd>
<dd><code>port</code> - The port to "connect" to.</dd>
<dd><code>autoClose</code> - If the underlying socket should be closed when the returned socket is closed.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The SSLSocket.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></code> - An Exception has occurred.</dd>
</dl>
</li>
</ul>
<a name="upgradeClientSocketToSSL-javax.net.ssl.SSLContext-java.net.Socket-java.lang.String-int-boolean-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>upgradeClientSocketToSSL</h4>
<pre>public static&nbsp;javax.net.ssl.SSLSocket&nbsp;upgradeClientSocketToSSL(javax.net.ssl.SSLContext&nbsp;sslContext,
java.net.Socket&nbsp;socket,
java.lang.String&nbsp;host,
int&nbsp;port,
boolean&nbsp;autoClose,
boolean&nbsp;onClient)
throws <a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></pre>
<div class="block">Upgrades an existing <code>Socket</code> to an <code>SSLSocket</code> using the specified <code>SSLContext</code>,
<code>Socket</code>, host, port and if the specified socket should be closed when the returned socket is closed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sslContext</code> - The SSL Context to create the socket from.</dd>
<dd><code>socket</code> - The socket to wrap.</dd>
<dd><code>host</code> - The host to "connect" to.</dd>
<dd><code>port</code> - The port to "connect" to.</dd>
<dd><code>autoClose</code> - If the underlying socket should be closed when the returned socket is closed.</dd>
<dd><code>onClient</code> - Is this being called on the client side.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The SSLSocket.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></code> - An Exception has occurred.</dd>
</dl>
</li>
</ul>
<a name="getSSLServerSocket-javax.net.ssl.SSLContext-int-int-java.net.InetAddress-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getSSLServerSocket</h4>
<pre>public static&nbsp;javax.net.ssl.SSLServerSocket&nbsp;getSSLServerSocket(javax.net.ssl.SSLContext&nbsp;sslContext,
int&nbsp;port,
int&nbsp;backlog,
java.net.InetAddress&nbsp;ifAddress)
throws <a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></pre>
<div class="block">Gets the SSL Server socket for the specified <code>SSLContext</code>, port, backlog and <code>InetAddress</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sslContext</code> - The SSL Context to create the socket from.</dd>
<dd><code>port</code> - The port to listen on.</dd>
<dd><code>backlog</code> - The number of connections that can be queued.</dd>
<dd><code>ifAddress</code> - The network interface to listen on (null means listen on all network interfaces).</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The SSLServerSocket.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</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>Prev&nbsp;Class</li>
<li><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/ssl/SSLUtilities.html" target="_top">Frames</a></li>
<li><a href="SSLUtilities.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>

View File

@ -0,0 +1,336 @@
<!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>SSLUtilityException</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="SSLUtilityException";
}
}
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><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/ssl/SSLUtilities.html" title="class in com.captainalm.lib.calmnet.ssl"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" target="_top">Frames</a></li>
<li><a href="SSLUtilityException.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="#methods.inherited.from.class.java.lang.Throwable">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>Method</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.ssl</div>
<h2 title="Class SSLUtilityException" class="title">Class SSLUtilityException</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.lang.Throwable</li>
<li>
<ul class="inheritance">
<li>java.lang.Exception</li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.ssl.SSLUtilityException</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">SSLUtilityException</span>
extends java.lang.Exception</pre>
<div class="block">This class provides the SSL Utility exception wrapper class.
See <code>Throwable.getCause()</code> to find out the underlying exception.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Captain ALM</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#com.captainalm.lib.calmnet.ssl.SSLUtilityException">Serialized Form</a></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/ssl/SSLUtilityException.html#SSLUtilityException-java.lang.String-">SSLUtilityException</a></span>(java.lang.String&nbsp;message)</code>
<div class="block">Constructs a new exception with the specified detail message.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html#SSLUtilityException-java.lang.String-java.lang.Throwable-">SSLUtilityException</a></span>(java.lang.String&nbsp;message,
java.lang.Throwable&nbsp;cause)</code>
<div class="block">Constructs a new exception with the specified detail message and
cause.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html#SSLUtilityException-java.lang.Throwable-">SSLUtilityException</a></span>(java.lang.Throwable&nbsp;cause)</code>
<div class="block">Constructs a new exception with the specified cause and a detail
message of <tt>(cause==null ? null : cause.toString())</tt> (which
typically contains the class and detail message of <tt>cause</tt>).</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Throwable</h3>
<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li>
</ul>
<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, 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="SSLUtilityException-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SSLUtilityException</h4>
<pre>public&nbsp;SSLUtilityException(java.lang.String&nbsp;message)</pre>
<div class="block">Constructs a new exception with the specified detail message. The
cause is not initialized, and may subsequently be initialized by
a call to <code>Throwable.initCause(java.lang.Throwable)</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - the detail message. The detail message is saved for
later retrieval by the <code>Throwable.getMessage()</code> method.</dd>
</dl>
</li>
</ul>
<a name="SSLUtilityException-java.lang.String-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SSLUtilityException</h4>
<pre>public&nbsp;SSLUtilityException(java.lang.String&nbsp;message,
java.lang.Throwable&nbsp;cause)</pre>
<div class="block">Constructs a new exception with the specified detail message and
cause. <p>Note that the detail message associated with
<code>cause</code> is <i>not</i> automatically incorporated in
this exception's detail message.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - the detail message (which is saved for later retrieval
by the <code>Throwable.getMessage()</code> method).</dd>
<dd><code>cause</code> - the cause (which is saved for later retrieval by the
<code>Throwable.getCause()</code> method). (A <tt>null</tt> value is
permitted, and indicates that the cause is nonexistent or
unknown.)</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.4</dd>
</dl>
</li>
</ul>
<a name="SSLUtilityException-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SSLUtilityException</h4>
<pre>public&nbsp;SSLUtilityException(java.lang.Throwable&nbsp;cause)</pre>
<div class="block">Constructs a new exception with the specified cause and a detail
message of <tt>(cause==null ? null : cause.toString())</tt> (which
typically contains the class and detail message of <tt>cause</tt>).
This constructor is useful for exceptions that are little more than
wrappers for other throwables (for example, <code>PrivilegedActionException</code>).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cause</code> - the cause (which is saved for later retrieval by the
<code>Throwable.getCause()</code> method). (A <tt>null</tt> value is
permitted, and indicates that the cause is nonexistent or
unknown.)</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.4</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/ssl/SSLUtilities.html" title="class in com.captainalm.lib.calmnet.ssl"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" target="_top">Frames</a></li>
<li><a href="SSLUtilityException.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="#methods.inherited.from.class.java.lang.Throwable">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>Method</li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>

View File

@ -0,0 +1,24 @@
<!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:22 BST 2023 -->
<title>com.captainalm.lib.calmnet.ssl</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>
<h1 class="bar"><a href="../../../../../com/captainalm/lib/calmnet/ssl/package-summary.html" target="classFrame">com.captainalm.lib.calmnet.ssl</a></h1>
<div class="indexContainer">
<h2 title="Classes">Classes</h2>
<ul title="Classes">
<li><a href="SSLUtilities.html" title="class in com.captainalm.lib.calmnet.ssl" target="classFrame">SSLUtilities</a></li>
</ul>
<h2 title="Exceptions">Exceptions</h2>
<ul title="Exceptions">
<li><a href="SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl" target="classFrame">SSLUtilityException</a></li>
</ul>
</div>
</body>
</html>

View File

@ -0,0 +1,175 @@
<!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:22 BST 2023 -->
<title>com.captainalm.lib.calmnet.ssl</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="com.captainalm.lib.calmnet.ssl";
}
}
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/fragment/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/stream/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/ssl/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.ssl</h1>
<div class="docSummary">
<div class="block">This package provides SSL utilities for wrapping
<code>Socket</code>s and creating <code>SSLContext</code>s.</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/ssl/SSLUtilities.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilities</a></td>
<td class="colLast">
<div class="block">This class provides SSL utilities to create <code>SSLContext</code> and <code>SSLSocket</code>
objects using JKS files (Or other supported formats).</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></td>
<td class="colLast">
<div class="block">This class provides the SSL Utility exception wrapper class.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package com.captainalm.lib.calmnet.ssl Description">Package com.captainalm.lib.calmnet.ssl Description</h2>
<div class="block">This package provides SSL utilities for wrapping
<code>Socket</code>s and creating <code>SSLContext</code>s.</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/fragment/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/stream/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/ssl/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>

View File

@ -0,0 +1,144 @@
<!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:22 BST 2023 -->
<title>com.captainalm.lib.calmnet.ssl Class Hierarchy</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="com.captainalm.lib.calmnet.ssl Class Hierarchy";
}
}
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><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</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/package-tree.html">Prev</a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/stream/package-tree.html">Next</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/ssl/package-tree.html" target="_top">Frames</a></li>
<li><a href="package-tree.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 class="title">Hierarchy For Package com.captainalm.lib.calmnet.ssl</h1>
<span class="packageHierarchyLabel">Package Hierarchies:</span>
<ul class="horizontal">
<li><a href="../../../../../overview-tree.html">All Packages</a></li>
</ul>
</div>
<div class="contentContainer">
<h2 title="Class Hierarchy">Class Hierarchy</h2>
<ul>
<li type="circle">java.lang.Object
<ul>
<li type="circle">com.captainalm.lib.calmnet.ssl.<a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilities.html" title="class in com.captainalm.lib.calmnet.ssl"><span class="typeNameLink">SSLUtilities</span></a></li>
<li type="circle">java.lang.Throwable (implements java.io.Serializable)
<ul>
<li type="circle">java.lang.Exception
<ul>
<li type="circle">com.captainalm.lib.calmnet.ssl.<a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl"><span class="typeNameLink">SSLUtilityException</span></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</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><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</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/package-tree.html">Prev</a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/stream/package-tree.html">Next</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/ssl/package-tree.html" target="_top">Frames</a></li>
<li><a href="package-tree.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>

View File

@ -0,0 +1,478 @@
<!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>LengthClampedInputStream</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="LengthClampedInputStream";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":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>Prev&nbsp;Class</li>
<li><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/stream/LengthClampedInputStream.html" target="_top">Frames</a></li>
<li><a href="LengthClampedInputStream.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.stream</div>
<h2 title="Class LengthClampedInputStream" class="title">Class LengthClampedInputStream</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.io.InputStream</li>
<li>
<ul class="inheritance">
<li>java.io.FilterInputStream</li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.stream.LengthClampedInputStream</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Closeable, java.lang.AutoCloseable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">LengthClampedInputStream</span>
extends java.io.FilterInputStream</pre>
<div class="block">This class provides the ability to limit the number of bytes read from the underlying stream.
When the limit is reached, this class considers that state as end of stream.</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/stream/LengthClampedInputStream.html#LengthClampedInputStream-java.io.InputStream-int-">LengthClampedInputStream</a></span>(java.io.InputStream&nbsp;inputStream,
int&nbsp;length)</code>
<div class="block">Creates a LengthClampedInputStream with the specified <code>InputStream</code>
and the maximum number of bytes that can be read from the stream.</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>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/LengthClampedInputStream.html#available--">available</a></span>()</code>
<div class="block">Returns an estimate of the number of bytes that can be read (or
skipped over) from this input stream without blocking by the next
caller of a method for this input stream.</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/stream/LengthClampedInputStream.html#close--">close</a></span>()</code>
<div class="block">Closes this input stream and releases any system resources
associated with the stream.</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/stream/LengthClampedInputStream.html#mark-int-">mark</a></span>(int&nbsp;readlimit)</code>
<div class="block">Marks the current position in this input stream.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/LengthClampedInputStream.html#read--">read</a></span>()</code>
<div class="block">Reads the next byte of data from this input stream.</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/stream/LengthClampedInputStream.html#reset--">reset</a></span>()</code>
<div class="block">Repositions this stream to the position at the time the
<code>mark</code> method was last called on this input stream.</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/stream/LengthClampedInputStream.html#setClampedLength-int-">setClampedLength</a></span>(int&nbsp;clampedLength)</code>
<div class="block">Sets a new clamped length value.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.io.FilterInputStream">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.io.FilterInputStream</h3>
<code>markSupported, read, read, skip</code></li>
</ul>
<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="LengthClampedInputStream-java.io.InputStream-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LengthClampedInputStream</h4>
<pre>public&nbsp;LengthClampedInputStream(java.io.InputStream&nbsp;inputStream,
int&nbsp;length)</pre>
<div class="block">Creates a LengthClampedInputStream with the specified <code>InputStream</code>
and the maximum number of bytes that can be read from the stream.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>inputStream</code> - The input stream to clamp.</dd>
<dd><code>length</code> - The maximum number of bytes that can be read before end of stream is reached.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - inputStream is null.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - length 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="read--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public&nbsp;int&nbsp;read()
throws java.io.IOException</pre>
<div class="block">Reads the next byte of data from this input stream. The value
byte is returned as an <code>int</code> in the range
<code>0</code> to <code>255</code>. If no byte is available
because the end of the stream has been reached, the value
<code>-1</code> is returned. This method blocks until input data
is available, the end of the stream is detected, or an exception
is thrown.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>read</code>&nbsp;in class&nbsp;<code>java.io.FilterInputStream</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the next byte of data, or <code>-1</code> if the end of the
stream is reached.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an I/O error occurs.</dd>
</dl>
</li>
</ul>
<a name="available--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>available</h4>
<pre>public&nbsp;int&nbsp;available()
throws java.io.IOException</pre>
<div class="block">Returns an estimate of the number of bytes that can be read (or
skipped over) from this input stream without blocking by the next
caller of a method for this input stream. The next caller might be
the same thread or another thread. A single read or skip of this
many bytes will not block, but may read or skip fewer bytes.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>available</code>&nbsp;in class&nbsp;<code>java.io.FilterInputStream</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an estimate of the number of bytes that can be read (or skipped
over) from this input stream without blocking.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an I/O error occurs.</dd>
</dl>
</li>
</ul>
<a name="mark-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mark</h4>
<pre>public&nbsp;void&nbsp;mark(int&nbsp;readlimit)</pre>
<div class="block">Marks the current position in this input stream. A subsequent
call to the <code>reset</code> method repositions this stream at
the last marked position so that subsequent reads re-read the same bytes.
<p>
The <code>readlimit</code> argument tells this input stream to
allow that many bytes to be read before the mark position gets
invalidated.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>mark</code>&nbsp;in class&nbsp;<code>java.io.FilterInputStream</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>readlimit</code> - the maximum limit of bytes that can be read before
the mark position becomes invalid.</dd>
</dl>
</li>
</ul>
<a name="reset--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre>public&nbsp;void&nbsp;reset()
throws java.io.IOException</pre>
<div class="block">Repositions this stream to the position at the time the
<code>mark</code> method was last called on this input stream.
<p>
Stream marks are intended to be used in
situations where you need to read ahead a little to see what's in
the stream. Often this is most easily done by invoking some
general parser. If the stream is of the type handled by the
parse, it just chugs along happily. If the stream is not of
that type, the parser should toss an exception when it fails.
If this happens within readlimit bytes, it allows the outer
code to reset the stream and try another parser.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>reset</code>&nbsp;in class&nbsp;<code>java.io.FilterInputStream</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if the stream has not been marked, if the
mark has been invalidated or marking is not supported.</dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()
throws java.io.IOException</pre>
<div class="block">Closes this input stream and releases any system resources
associated with the stream.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.io.Closeable</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>close</code>&nbsp;in class&nbsp;<code>java.io.FilterInputStream</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an I/O error occurs.</dd>
</dl>
</li>
</ul>
<a name="setClampedLength-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setClampedLength</h4>
<pre>public&nbsp;void&nbsp;setClampedLength(int&nbsp;clampedLength)</pre>
<div class="block">Sets a new clamped length value.
This is the maximum number of bytes that can be read from the stream.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clampedLength</code> - The new clamped length value.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - clampedLength is less than 0.</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>Prev&nbsp;Class</li>
<li><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/stream/LengthClampedInputStream.html" target="_top">Frames</a></li>
<li><a href="LengthClampedInputStream.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>

View File

@ -0,0 +1,679 @@
<!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>NetworkInputStream</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="NetworkInputStream";
}
}
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};
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/stream/LengthClampedInputStream.html" title="class in com.captainalm.lib.calmnet.stream"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/stream/NetworkInputStream.html" target="_top">Frames</a></li>
<li><a href="NetworkInputStream.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.stream</div>
<h2 title="Class NetworkInputStream" class="title">Class NetworkInputStream</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.io.InputStream</li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.stream.NetworkInputStream</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Closeable, java.lang.AutoCloseable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">NetworkInputStream</span>
extends java.io.InputStream</pre>
<div class="block">This class provides a Network Input stream for either <code>Socket</code>s or <code>DatagramSocket</code>s.</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/stream/NetworkInputStream.html#NetworkInputStream-java.net.DatagramSocket-">NetworkInputStream</a></span>(java.net.DatagramSocket&nbsp;socketIn)</code>
<div class="block">Constructs a new NetworkInputStream with the specified <code>DatagramSocket</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#NetworkInputStream-java.net.Socket-">NetworkInputStream</a></span>(java.net.Socket&nbsp;socketIn)</code>
<div class="block">Constructs a new NetworkInputStream with the specified <code>Socket</code>.</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>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#available--">available</a></span>()</code>
<div class="block">Returns an estimate of the number of bytes that can be read (or
skipped over) from this input stream without blocking by the next
invocation of a method for this input stream.</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/stream/NetworkInputStream.html#close--">close</a></span>()</code>
<div class="block">Closes this input stream and releases any system resources associated
with the stream.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.net.InetAddress</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#getAddress--">getAddress</a></span>()</code>
<div class="block">Gets the current <code>InetAddress</code> of the stream.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.net.DatagramSocket</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#getDatagramSocket--">getDatagramSocket</a></span>()</code>
<div class="block">Gets the datagram socket in use or null.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.net.InetAddress</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#getLocalAddress--">getLocalAddress</a></span>()</code>
<div class="block">Gets the local <code>InetAddress</code> of the stream.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.Integer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#getLocalPort--">getLocalPort</a></span>()</code>
<div class="block">Gets the local port of the stream.</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/stream/NetworkInputStream.html#getPacketSize--">getPacketSize</a></span>()</code>
<div class="block">Gets the current datagram packet size.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.Integer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#getPort--">getPort</a></span>()</code>
<div class="block">Gets the current port of the stream.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.net.Socket</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#getSocket--">getSocket</a></span>()</code>
<div class="block">Gets the socket in use or null.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#read--">read</a></span>()</code>
<div class="block">Reads the next byte of data from the input stream.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#readPacket--">readPacket</a></span>()</code>
<div class="block">Reads a single datagram packet.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#readPacket-byte:A-">readPacket</a></span>(byte[]&nbsp;b)</code>
<div class="block">Reads a single datagram packet into the specified buffer storing with no offset.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#readPacket-byte:A-int-int-">readPacket</a></span>(byte[]&nbsp;b,
int&nbsp;off,
int&nbsp;len)</code>
<div class="block">Reads a single datagram packet into the specified buffer
storing from the specified offset and the specified number of bytes.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#setDatagramSocket-java.net.DatagramSocket-">setDatagramSocket</a></span>(java.net.DatagramSocket&nbsp;socketIn)</code>
<div class="block">Sets the datagram socket in use.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#setSocket-java.net.Socket-">setSocket</a></span>(java.net.Socket&nbsp;socketIn)</code>
<div class="block">Sets the socket in use.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.io.InputStream">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.io.InputStream</h3>
<code>mark, markSupported, read, read, reset, skip</code></li>
</ul>
<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="NetworkInputStream-java.net.Socket-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NetworkInputStream</h4>
<pre>public&nbsp;NetworkInputStream(java.net.Socket&nbsp;socketIn)</pre>
<div class="block">Constructs a new NetworkInputStream with the specified <code>Socket</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>socketIn</code> - The socket to use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - socketIn is null.</dd>
</dl>
</li>
</ul>
<a name="NetworkInputStream-java.net.DatagramSocket-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NetworkInputStream</h4>
<pre>public&nbsp;NetworkInputStream(java.net.DatagramSocket&nbsp;socketIn)</pre>
<div class="block">Constructs a new NetworkInputStream with the specified <code>DatagramSocket</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>socketIn</code> - The datagram socket to use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - socketIn 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="read--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public&nbsp;int&nbsp;read()
throws java.io.IOException</pre>
<div class="block">Reads the next byte of data from the input stream. The value byte is
returned as an <code>int</code> in the range <code>0</code> to
<code>255</code>. If no byte is available because the end of the stream
has been reached, the value <code>-1</code> is returned. This method
blocks until input data is available, the end of the stream is detected,
or an exception is thrown.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>read</code>&nbsp;in class&nbsp;<code>java.io.InputStream</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the next byte of data, or <code>-1</code> if the end of the
stream is reached.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an I/O error occurs.</dd>
</dl>
</li>
</ul>
<a name="readPacket--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readPacket</h4>
<pre>public&nbsp;byte[]&nbsp;readPacket()
throws java.io.IOException</pre>
<div class="block">Reads a single datagram packet.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A byte array of the single datagram packet.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an I/O error occurs, stream closed or not using a datagram socket.</dd>
</dl>
</li>
</ul>
<a name="readPacket-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readPacket</h4>
<pre>public&nbsp;int&nbsp;readPacket(byte[]&nbsp;b)
throws java.io.IOException</pre>
<div class="block">Reads a single datagram packet into the specified buffer storing with no offset.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>b</code> - The buffer to store the packet in.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of bytes stored or -1 for end of stream.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - b is null.</dd>
<dd><code>java.io.IOException</code> - if an I/O error occurs, stream closed or not using a datagram socket.</dd>
</dl>
</li>
</ul>
<a name="readPacket-byte:A-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readPacket</h4>
<pre>public&nbsp;int&nbsp;readPacket(byte[]&nbsp;b,
int&nbsp;off,
int&nbsp;len)
throws java.io.IOException</pre>
<div class="block">Reads a single datagram packet into the specified buffer
storing from the specified offset and the specified number of bytes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>b</code> - The buffer to store the packet in.</dd>
<dd><code>off</code> - The offset to store in the buffer from.</dd>
<dd><code>len</code> - The number of bytes to store in the buffer.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of bytes stored or -1 for end of stream.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - b is null.</dd>
<dd><code>java.lang.IndexOutOfBoundsException</code> - if off is negative, len is negative, or len is greater than the difference of the length of the buffer and off.</dd>
<dd><code>java.io.IOException</code> - if an I/O error occurs, stream closed or not using a datagram socket.</dd>
</dl>
</li>
</ul>
<a name="getPacketSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPacketSize</h4>
<pre>public&nbsp;int&nbsp;getPacketSize()
throws java.io.IOException</pre>
<div class="block">Gets the current datagram packet size.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The datagram packet size.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - stream closed or not using a datagram socket.</dd>
</dl>
</li>
</ul>
<a name="getAddress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAddress</h4>
<pre>public&nbsp;java.net.InetAddress&nbsp;getAddress()</pre>
<div class="block">Gets the current <code>InetAddress</code> of the stream.
Can be null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The address.</dd>
</dl>
</li>
</ul>
<a name="getPort--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPort</h4>
<pre>public&nbsp;java.lang.Integer&nbsp;getPort()</pre>
<div class="block">Gets the current port of the stream.
Can be -1.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The current port.</dd>
</dl>
</li>
</ul>
<a name="getLocalAddress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalAddress</h4>
<pre>public&nbsp;java.net.InetAddress&nbsp;getLocalAddress()</pre>
<div class="block">Gets the local <code>InetAddress</code> of the stream.
Can be null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The local address.</dd>
</dl>
</li>
</ul>
<a name="getLocalPort--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalPort</h4>
<pre>public&nbsp;java.lang.Integer&nbsp;getLocalPort()</pre>
<div class="block">Gets the local port of the stream.
Can be -1.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The local port.</dd>
</dl>
</li>
</ul>
<a name="getSocket--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSocket</h4>
<pre>public&nbsp;java.net.Socket&nbsp;getSocket()</pre>
<div class="block">Gets the socket in use or null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The socket in use or null.</dd>
</dl>
</li>
</ul>
<a name="setSocket-java.net.Socket-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSocket</h4>
<pre>public&nbsp;void&nbsp;setSocket(java.net.Socket&nbsp;socketIn)
throws java.io.IOException</pre>
<div class="block">Sets the socket in use.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>socketIn</code> - The socket to now use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - socketIn is null.</dd>
<dd><code>java.io.IOException</code> - stream closed or not using a socket.</dd>
</dl>
</li>
</ul>
<a name="getDatagramSocket--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDatagramSocket</h4>
<pre>public&nbsp;java.net.DatagramSocket&nbsp;getDatagramSocket()</pre>
<div class="block">Gets the datagram socket in use or null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The datagram socket in use or null.</dd>
</dl>
</li>
</ul>
<a name="setDatagramSocket-java.net.DatagramSocket-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDatagramSocket</h4>
<pre>public&nbsp;void&nbsp;setDatagramSocket(java.net.DatagramSocket&nbsp;socketIn)
throws java.io.IOException</pre>
<div class="block">Sets the datagram socket in use.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>socketIn</code> - The datagram socket to now use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - socketIn is null.</dd>
<dd><code>java.io.IOException</code> - stream closed or not using a datagram socket.</dd>
</dl>
</li>
</ul>
<a name="available--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>available</h4>
<pre>public&nbsp;int&nbsp;available()
throws java.io.IOException</pre>
<div class="block">Returns an estimate of the number of bytes that can be read (or
skipped over) from this input stream without blocking by the next
invocation of a method for this input stream. The next invocation
might be the same thread or another thread. A single read or skip of this
many bytes will not block, but may read or skip fewer bytes.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>available</code>&nbsp;in class&nbsp;<code>java.io.InputStream</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an estimate of the number of bytes that can be read (or skipped
over) from this input stream without blocking or <code>0</code> when
it reaches the end of the input stream.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an I/O error occurs.</dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()
throws java.io.IOException</pre>
<div class="block">Closes this input stream and releases any system resources associated
with the stream. The underlying socket is closed.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.io.Closeable</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>close</code>&nbsp;in class&nbsp;<code>java.io.InputStream</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an I/O error occurs.</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/stream/LengthClampedInputStream.html" title="class in com.captainalm.lib.calmnet.stream"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/stream/NetworkInputStream.html" target="_top">Frames</a></li>
<li><a href="NetworkInputStream.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>

View File

@ -0,0 +1,700 @@
<!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>NetworkOutputStream</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="NetworkOutputStream";
}
}
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};
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/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" target="_top">Frames</a></li>
<li><a href="NetworkOutputStream.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.stream</div>
<h2 title="Class NetworkOutputStream" class="title">Class NetworkOutputStream</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.io.OutputStream</li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.stream.NetworkOutputStream</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">NetworkOutputStream</span>
extends java.io.OutputStream</pre>
<div class="block">This class provides a Network Output stream for either <code>Socket</code>s or <code>DatagramSocket</code>s.</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/stream/NetworkOutputStream.html#NetworkOutputStream-java.net.DatagramSocket-">NetworkOutputStream</a></span>(java.net.DatagramSocket&nbsp;socketIn)</code>
<div class="block">Constructs a new NetworkOutputStream with the specified <code>DatagramSocket</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#NetworkOutputStream-java.net.DatagramSocket-int-">NetworkOutputStream</a></span>(java.net.DatagramSocket&nbsp;socketIn,
int&nbsp;size)</code>
<div class="block">Constructs a new NetworkOutputStream with the specified <code>DatagramSocket</code> and datagram buffer size.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#NetworkOutputStream-java.net.DatagramSocket-int-java.net.InetAddress-int-">NetworkOutputStream</a></span>(java.net.DatagramSocket&nbsp;socketIn,
int&nbsp;size,
java.net.InetAddress&nbsp;address,
int&nbsp;port)</code>
<div class="block">Constructs a new NetworkOutputStream with the specified <code>DatagramSocket</code>, datagram buffer size, <code>InetAddress</code> target and port target.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#NetworkOutputStream-java.net.Socket-">NetworkOutputStream</a></span>(java.net.Socket&nbsp;socketIn)</code>
<div class="block">Constructs a new NetworkOutputStream with the specified <code>Socket</code>.</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/stream/NetworkOutputStream.html#canDatagramBufferBeSet--">canDatagramBufferBeSet</a></span>()</code>
<div class="block">Gets if the <a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#setDatagramBufferSize-int-"><code>setDatagramBufferSize(int)</code></a> can be used.</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/stream/NetworkOutputStream.html#close--">close</a></span>()</code>
<div class="block">Closes this output stream and releases any system resources
associated with this stream.</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/stream/NetworkOutputStream.html#flush--">flush</a></span>()</code>
<div class="block">Flushes this output stream and forces any buffered output bytes
to be written out.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.net.InetAddress</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#getAddress--">getAddress</a></span>()</code>
<div class="block">Gets the current <code>InetAddress</code> of the stream.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.net.DatagramSocket</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#getDatagramSocket--">getDatagramSocket</a></span>()</code>
<div class="block">Gets the datagram socket in use or null.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.net.InetAddress</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#getLocalAddress--">getLocalAddress</a></span>()</code>
<div class="block">Gets the local <code>InetAddress</code> of the stream.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.Integer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#getLocalPort--">getLocalPort</a></span>()</code>
<div class="block">Gets the local port of the stream.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.Integer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#getPort--">getPort</a></span>()</code>
<div class="block">Gets the current port of the stream.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.net.Socket</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#getSocket--">getSocket</a></span>()</code>
<div class="block">Gets the socket in use or null.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#setDatagramBufferSize-int-">setDatagramBufferSize</a></span>(int&nbsp;size)</code>
<div class="block">Sets the buffer size for sending datagrams.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#setDatagramSocket-java.net.DatagramSocket-">setDatagramSocket</a></span>(java.net.DatagramSocket&nbsp;socketIn)</code>
<div class="block">Sets the datagram socket in use.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#setDatagramTarget-java.net.InetAddress-int-">setDatagramTarget</a></span>(java.net.InetAddress&nbsp;address,
int&nbsp;port)</code>
<div class="block">Sets the datagram target <code>InetAddress</code> and port.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#setSocket-java.net.Socket-">setSocket</a></span>(java.net.Socket&nbsp;socketIn)</code>
<div class="block">Sets the socket in use.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#write-int-">write</a></span>(int&nbsp;b)</code>
<div class="block">Writes the specified byte to this output stream.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.io.OutputStream">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.io.OutputStream</h3>
<code>write, write</code></li>
</ul>
<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="NetworkOutputStream-java.net.Socket-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NetworkOutputStream</h4>
<pre>public&nbsp;NetworkOutputStream(java.net.Socket&nbsp;socketIn)</pre>
<div class="block">Constructs a new NetworkOutputStream with the specified <code>Socket</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>socketIn</code> - The socket to use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - socketIn is null.</dd>
</dl>
</li>
</ul>
<a name="NetworkOutputStream-java.net.DatagramSocket-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NetworkOutputStream</h4>
<pre>public&nbsp;NetworkOutputStream(java.net.DatagramSocket&nbsp;socketIn)</pre>
<div class="block">Constructs a new NetworkOutputStream with the specified <code>DatagramSocket</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>socketIn</code> - The datagram socket to use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - socketIn is null.</dd>
</dl>
</li>
</ul>
<a name="NetworkOutputStream-java.net.DatagramSocket-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NetworkOutputStream</h4>
<pre>public&nbsp;NetworkOutputStream(java.net.DatagramSocket&nbsp;socketIn,
int&nbsp;size)</pre>
<div class="block">Constructs a new NetworkOutputStream with the specified <code>DatagramSocket</code> and datagram buffer size.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>socketIn</code> - The datagram socket to use.</dd>
<dd><code>size</code> - The size of the buffer.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - socketIn is null.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - size is less than 1 or greater than 65535.</dd>
</dl>
</li>
</ul>
<a name="NetworkOutputStream-java.net.DatagramSocket-int-java.net.InetAddress-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NetworkOutputStream</h4>
<pre>public&nbsp;NetworkOutputStream(java.net.DatagramSocket&nbsp;socketIn,
int&nbsp;size,
java.net.InetAddress&nbsp;address,
int&nbsp;port)</pre>
<div class="block">Constructs a new NetworkOutputStream with the specified <code>DatagramSocket</code>, datagram buffer size, <code>InetAddress</code> target and port target.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>socketIn</code> - The datagram socket to use.</dd>
<dd><code>size</code> - The size of the buffer.</dd>
<dd><code>address</code> - The target address to set to.</dd>
<dd><code>port</code> - The target port to set to.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - socketIn or address is null.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - size is less than 1 or greater than 65535 or port is less than 0 or greater than 65535.</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="canDatagramBufferBeSet--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canDatagramBufferBeSet</h4>
<pre>public&nbsp;boolean&nbsp;canDatagramBufferBeSet()</pre>
<div class="block">Gets if the <a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#setDatagramBufferSize-int-"><code>setDatagramBufferSize(int)</code></a> can be used.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If the datagram buffer size can be set.</dd>
</dl>
</li>
</ul>
<a name="setDatagramBufferSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDatagramBufferSize</h4>
<pre>public&nbsp;void&nbsp;setDatagramBufferSize(int&nbsp;size)
throws java.io.IOException</pre>
<div class="block">Sets the buffer size for sending datagrams.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>size</code> - The size to set to.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - size is less than 1 or greater than 65535.</dd>
<dd><code>java.io.IOException</code> - a datagram socket is not in use, buffer index is not null or the stream is closed.</dd>
</dl>
</li>
</ul>
<a name="setDatagramTarget-java.net.InetAddress-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDatagramTarget</h4>
<pre>public&nbsp;void&nbsp;setDatagramTarget(java.net.InetAddress&nbsp;address,
int&nbsp;port)
throws java.io.IOException</pre>
<div class="block">Sets the datagram target <code>InetAddress</code> and port.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>address</code> - The address to set to.</dd>
<dd><code>port</code> - The port to set to.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - address is null.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - port is less than 0 or greater than 65535.</dd>
<dd><code>java.io.IOException</code> - a datagram socket is not in use or the stream is closed.</dd>
</dl>
</li>
</ul>
<a name="write-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>write</h4>
<pre>public&nbsp;void&nbsp;write(int&nbsp;b)
throws java.io.IOException</pre>
<div class="block">Writes the specified byte to this output stream. The general
contract for <code>write</code> is that one byte is written
to the output stream. The byte to be written is the eight
low-order bits of the argument <code>b</code>. The 24
high-order bits of <code>b</code> are ignored.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>write</code>&nbsp;in class&nbsp;<code>java.io.OutputStream</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>b</code> - the <code>byte</code>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an I/O error occurs. In particular,
an <code>IOException</code> will be thrown if the
output stream has been closed.</dd>
</dl>
</li>
</ul>
<a name="getAddress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAddress</h4>
<pre>public&nbsp;java.net.InetAddress&nbsp;getAddress()</pre>
<div class="block">Gets the current <code>InetAddress</code> of the stream.
Can be null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The address.</dd>
</dl>
</li>
</ul>
<a name="getPort--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPort</h4>
<pre>public&nbsp;java.lang.Integer&nbsp;getPort()</pre>
<div class="block">Gets the current port of the stream.
Can be -1.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The current port.</dd>
</dl>
</li>
</ul>
<a name="getLocalAddress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalAddress</h4>
<pre>public&nbsp;java.net.InetAddress&nbsp;getLocalAddress()</pre>
<div class="block">Gets the local <code>InetAddress</code> of the stream.
Can be null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The local address.</dd>
</dl>
</li>
</ul>
<a name="getLocalPort--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalPort</h4>
<pre>public&nbsp;java.lang.Integer&nbsp;getLocalPort()</pre>
<div class="block">Gets the local port of the stream.
Can be -1.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The local port.</dd>
</dl>
</li>
</ul>
<a name="getSocket--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSocket</h4>
<pre>public&nbsp;java.net.Socket&nbsp;getSocket()</pre>
<div class="block">Gets the socket in use or null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The socket in use or null.</dd>
</dl>
</li>
</ul>
<a name="setSocket-java.net.Socket-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSocket</h4>
<pre>public&nbsp;void&nbsp;setSocket(java.net.Socket&nbsp;socketIn)
throws java.io.IOException</pre>
<div class="block">Sets the socket in use.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>socketIn</code> - The socket to now use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - socketIn is null.</dd>
<dd><code>java.io.IOException</code> - stream closed or not using a socket.</dd>
</dl>
</li>
</ul>
<a name="getDatagramSocket--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDatagramSocket</h4>
<pre>public&nbsp;java.net.DatagramSocket&nbsp;getDatagramSocket()</pre>
<div class="block">Gets the datagram socket in use or null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The datagram socket in use or null.</dd>
</dl>
</li>
</ul>
<a name="setDatagramSocket-java.net.DatagramSocket-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDatagramSocket</h4>
<pre>public&nbsp;void&nbsp;setDatagramSocket(java.net.DatagramSocket&nbsp;socketIn)
throws java.io.IOException</pre>
<div class="block">Sets the datagram socket in use.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>socketIn</code> - The datagram socket to now use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - socketIn is null.</dd>
<dd><code>java.io.IOException</code> - stream closed or not using a datagram socket.</dd>
</dl>
</li>
</ul>
<a name="flush--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flush</h4>
<pre>public&nbsp;void&nbsp;flush()
throws java.io.IOException</pre>
<div class="block">Flushes this output stream and forces any buffered output bytes
to be written out. The general contract of <code>flush</code> is
that calling it is an indication that, if any bytes previously
written have been buffered by the implementation of the output
stream, such bytes should immediately be written to their
intended destination.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>flush</code>&nbsp;in interface&nbsp;<code>java.io.Flushable</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>flush</code>&nbsp;in class&nbsp;<code>java.io.OutputStream</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an I/O error occurs.</dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()
throws java.io.IOException</pre>
<div class="block">Closes this output stream and releases any system resources
associated with this stream. The general contract of <code>close</code>
is that it closes the output stream. A closed stream cannot perform
output operations and cannot be reopened. The underlying socket is closed.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.io.Closeable</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>close</code>&nbsp;in class&nbsp;<code>java.io.OutputStream</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an I/O error occurs.</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/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" target="_top">Frames</a></li>
<li><a href="NetworkOutputStream.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>

View File

@ -0,0 +1,22 @@
<!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:22 BST 2023 -->
<title>com.captainalm.lib.calmnet.stream</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>
<h1 class="bar"><a href="../../../../../com/captainalm/lib/calmnet/stream/package-summary.html" target="classFrame">com.captainalm.lib.calmnet.stream</a></h1>
<div class="indexContainer">
<h2 title="Classes">Classes</h2>
<ul title="Classes">
<li><a href="LengthClampedInputStream.html" title="class in com.captainalm.lib.calmnet.stream" target="classFrame">LengthClampedInputStream</a></li>
<li><a href="NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream" target="classFrame">NetworkInputStream</a></li>
<li><a href="NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream" target="classFrame">NetworkOutputStream</a></li>
</ul>
</div>
</body>
</html>

View File

@ -0,0 +1,167 @@
<!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:22 BST 2023 -->
<title>com.captainalm.lib.calmnet.stream</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="com.captainalm.lib.calmnet.stream";
}
}
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/ssl/package-summary.html">Prev&nbsp;Package</a></li>
<li>Next&nbsp;Package</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/stream/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.stream</h1>
<div class="docSummary">
<div class="block">This package provides streams for network packet streaming.</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/stream/LengthClampedInputStream.html" title="class in com.captainalm.lib.calmnet.stream">LengthClampedInputStream</a></td>
<td class="colLast">
<div class="block">This class provides the ability to limit the number of bytes read from the underlying stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkInputStream</a></td>
<td class="colLast">
<div class="block">This class provides a Network Input stream for either <code>Socket</code>s or <code>DatagramSocket</code>s.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkOutputStream</a></td>
<td class="colLast">
<div class="block">This class provides a Network Output stream for either <code>Socket</code>s or <code>DatagramSocket</code>s.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package com.captainalm.lib.calmnet.stream Description">Package com.captainalm.lib.calmnet.stream Description</h2>
<div class="block">This package provides streams for network packet streaming.</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/ssl/package-summary.html">Prev&nbsp;Package</a></li>
<li>Next&nbsp;Package</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/stream/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>

View File

@ -0,0 +1,149 @@
<!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:22 BST 2023 -->
<title>com.captainalm.lib.calmnet.stream Class Hierarchy</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="com.captainalm.lib.calmnet.stream Class Hierarchy";
}
}
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><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</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/ssl/package-tree.html">Prev</a></li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/stream/package-tree.html" target="_top">Frames</a></li>
<li><a href="package-tree.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 class="title">Hierarchy For Package com.captainalm.lib.calmnet.stream</h1>
<span class="packageHierarchyLabel">Package Hierarchies:</span>
<ul class="horizontal">
<li><a href="../../../../../overview-tree.html">All Packages</a></li>
</ul>
</div>
<div class="contentContainer">
<h2 title="Class Hierarchy">Class Hierarchy</h2>
<ul>
<li type="circle">java.lang.Object
<ul>
<li type="circle">java.io.InputStream (implements java.io.Closeable)
<ul>
<li type="circle">java.io.FilterInputStream
<ul>
<li type="circle">com.captainalm.lib.calmnet.stream.<a href="../../../../../com/captainalm/lib/calmnet/stream/LengthClampedInputStream.html" title="class in com.captainalm.lib.calmnet.stream"><span class="typeNameLink">LengthClampedInputStream</span></a></li>
</ul>
</li>
<li type="circle">com.captainalm.lib.calmnet.stream.<a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream"><span class="typeNameLink">NetworkInputStream</span></a></li>
</ul>
</li>
<li type="circle">java.io.OutputStream (implements java.io.Closeable, java.io.Flushable)
<ul>
<li type="circle">com.captainalm.lib.calmnet.stream.<a href="../../../../../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream"><span class="typeNameLink">NetworkOutputStream</span></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</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><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</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/ssl/package-tree.html">Prev</a></li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/stream/package-tree.html" target="_top">Frames</a></li>
<li><a href="package-tree.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>

View File

@ -0,0 +1,122 @@
<!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:22 BST 2023 -->
<title>Constant Field Values</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="Constant Field Values";
}
}
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>Package</li>
<li>Class</li>
<li><a href="overview-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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?constant-values.html" target="_top">Frames</a></li>
<li><a href="constant-values.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="Constant Field Values" class="title">Constant Field Values</h1>
<h2 title="Contents">Contents</h2>
</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>Package</li>
<li>Class</li>
<li><a href="overview-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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?constant-values.html" target="_top">Frames</a></li>
<li><a href="constant-values.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>

View File

@ -0,0 +1,122 @@
<!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:22 BST 2023 -->
<title>Deprecated List</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="Deprecated List";
}
}
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>Package</li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
<li class="navBarCell1Rev">Deprecated</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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?deprecated-list.html" target="_top">Frames</a></li>
<li><a href="deprecated-list.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="Deprecated API" class="title">Deprecated API</h1>
<h2 title="Contents">Contents</h2>
</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>Package</li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
<li class="navBarCell1Rev">Deprecated</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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?deprecated-list.html" target="_top">Frames</a></li>
<li><a href="deprecated-list.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>

223
JavaDoc/help-doc.html Normal file
View File

@ -0,0 +1,223 @@
<!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:22 BST 2023 -->
<title>API Help</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="API Help";
}
}
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>Package</li>
<li>Class</li>
<li><a href="overview-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 class="navBarCell1Rev">Help</li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?help-doc.html" target="_top">Frames</a></li>
<li><a href="help-doc.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 class="title">How This API Document Is Organized</h1>
<div class="subTitle">This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.</div>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<h2>Overview</h2>
<p>The <a href="overview-summary.html">Overview</a> page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.</p>
</li>
<li class="blockList">
<h2>Package</h2>
<p>Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:</p>
<ul>
<li>Interfaces (italic)</li>
<li>Classes</li>
<li>Enums</li>
<li>Exceptions</li>
<li>Errors</li>
<li>Annotation Types</li>
</ul>
</li>
<li class="blockList">
<h2>Class/Interface</h2>
<p>Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:</p>
<ul>
<li>Class inheritance diagram</li>
<li>Direct Subclasses</li>
<li>All Known Subinterfaces</li>
<li>All Known Implementing Classes</li>
<li>Class/interface declaration</li>
<li>Class/interface description</li>
</ul>
<ul>
<li>Nested Class Summary</li>
<li>Field Summary</li>
<li>Constructor Summary</li>
<li>Method Summary</li>
</ul>
<ul>
<li>Field Detail</li>
<li>Constructor Detail</li>
<li>Method Detail</li>
</ul>
<p>Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.</p>
</li>
<li class="blockList">
<h2>Annotation Type</h2>
<p>Each annotation type has its own separate page with the following sections:</p>
<ul>
<li>Annotation Type declaration</li>
<li>Annotation Type description</li>
<li>Required Element Summary</li>
<li>Optional Element Summary</li>
<li>Element Detail</li>
</ul>
</li>
<li class="blockList">
<h2>Enum</h2>
<p>Each enum has its own separate page with the following sections:</p>
<ul>
<li>Enum declaration</li>
<li>Enum description</li>
<li>Enum Constant Summary</li>
<li>Enum Constant Detail</li>
</ul>
</li>
<li class="blockList">
<h2>Tree (Class Hierarchy)</h2>
<p>There is a <a href="overview-tree.html">Class Hierarchy</a> page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with <code>java.lang.Object</code>. The interfaces do not inherit from <code>java.lang.Object</code>.</p>
<ul>
<li>When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.</li>
<li>When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.</li>
</ul>
</li>
<li class="blockList">
<h2>Deprecated API</h2>
<p>The <a href="deprecated-list.html">Deprecated API</a> page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.</p>
</li>
<li class="blockList">
<h2>Index</h2>
<p>The <a href="index-files/index-1.html">Index</a> contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.</p>
</li>
<li class="blockList">
<h2>Prev/Next</h2>
<p>These links take you to the next or previous class, interface, package, or related page.</p>
</li>
<li class="blockList">
<h2>Frames/No Frames</h2>
<p>These links show and hide the HTML frames. All pages are available with or without frames.</p>
</li>
<li class="blockList">
<h2>All Classes</h2>
<p>The <a href="allclasses-noframe.html">All Classes</a> link shows all classes and interfaces except non-static nested types.</p>
</li>
<li class="blockList">
<h2>Serialized Form</h2>
<p>Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.</p>
</li>
<li class="blockList">
<h2>Constant Field Values</h2>
<p>The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.</p>
</li>
</ul>
<span class="emphasizedPhrase">This help file applies to API documentation generated using the standard doclet.</span></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>Package</li>
<li>Class</li>
<li><a href="overview-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 class="navBarCell1Rev">Help</li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?help-doc.html" target="_top">Frames</a></li>
<li><a href="help-doc.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>

View File

@ -0,0 +1,189 @@
<!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:22 BST 2023 -->
<title>A-Index</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="A-Index";
}
}
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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Letter</li>
<li><a href="index-2.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-1.html" target="_top">Frames</a></li>
<li><a href="index-1.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="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;<a name="I:A">
<!-- -->
</a>
<h2 class="title">A</h2>
<dl>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/CandidateClient.html#accept">accept</a></span> - Variable in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/CandidateClient.html" title="class in com.captainalm.lib.calmnet.marshal">CandidateClient</a></dt>
<dd>
<div class="block">Whether the candidate should be accepted.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/CandidateClient.html#address">address</a></span> - Variable in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/CandidateClient.html" title="class in com.captainalm.lib.calmnet.marshal">CandidateClient</a></dt>
<dd>
<div class="block">The remote address of the candidate.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html#allocationSuccessful--">allocationSuccessful()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentAllocationPacket</a></dt>
<dd>
<div class="block">Checks if the allocation is successful.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#areFinishedIDsWaiting--">areFinishedIDsWaiting()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></dt>
<dd>
<div class="block">Gets whether finished IDs are waiting for obtaining.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#areFinishedIDsWaiting--">areFinishedIDsWaiting()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a></dt>
<dd>
<div class="block">Gets whether finished IDs are waiting for obtaining.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html#areInvalidPacketsAllowed--">areInvalidPacketsAllowed()</a></span> - Method in class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a></dt>
<dd>
<div class="block">Gets whether invalid packets are allowed to be read and written.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#arePacketsBeingRead--">arePacketsBeingRead()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Are <a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>s being read.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#arePacketsWaiting--">arePacketsWaiting()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></dt>
<dd>
<div class="block">Gets whether packets are waiting to be received.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#arePacketsWaiting--">arePacketsWaiting()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a></dt>
<dd>
<div class="block">Gets whether packets are waiting for allocation.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#areReceivedPacketsWaiting--">areReceivedPacketsWaiting()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Gets if there are received <a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>s.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#areSecretsSent--">areSecretsSent()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionUpgradePacket</a></dt>
<dd>
<div class="block">Gets if secrets are sent as part of cipher settings.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#areStreamPacketsPreferred--">areStreamPacketsPreferred()</a></span> - Method in class com.captainalm.lib.calmnet.packet.factory.<a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactory</a></dt>
<dd>
<div class="block">Gets if <a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#getPacket-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-"><code>CALMNETPacketFactory.getPacket(PacketProtocolInformation)</code></a> prefers returning <a href="../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a>s if possible.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html#areStreamPacketsPreferred--">areStreamPacketsPreferred()</a></span> - Method in interface com.captainalm.lib.calmnet.packet.factory.<a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a></dt>
<dd>
<div class="block">Gets if <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html#getPacket-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-"><code>getPacket(PacketProtocolInformation)</code></a> prefers returning <a href="../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a>s if possible.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/LengthClampedInputStream.html#available--">available()</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/LengthClampedInputStream.html" title="class in com.captainalm.lib.calmnet.stream">LengthClampedInputStream</a></dt>
<dd>
<div class="block">Returns an estimate of the number of bytes that can be read (or
skipped over) from this input stream without blocking by the next
caller of a method for this input stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#available--">available()</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkInputStream</a></dt>
<dd>
<div class="block">Returns an estimate of the number of bytes that can be read (or
skipped over) from this input stream without blocking by the next
invocation of a method for this input stream.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;</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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Letter</li>
<li><a href="index-2.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-1.html" target="_top">Frames</a></li>
<li><a href="index-1.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>

View File

@ -0,0 +1,206 @@
<!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:22 BST 2023 -->
<title>L-Index</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="L-Index";
}
}
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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-9.html">Prev Letter</a></li>
<li><a href="index-11.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-10.html" target="_top">Frames</a></li>
<li><a href="index-10.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="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;<a name="I:L">
<!-- -->
</a>
<h2 class="title">L</h2>
<dl>
<dt><a href="../com/captainalm/lib/calmnet/stream/LengthClampedInputStream.html" title="class in com.captainalm.lib.calmnet.stream"><span class="typeNameLink">LengthClampedInputStream</span></a> - Class in <a href="../com/captainalm/lib/calmnet/stream/package-summary.html">com.captainalm.lib.calmnet.stream</a></dt>
<dd>
<div class="block">This class provides the ability to limit the number of bytes read from the underlying stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/LengthClampedInputStream.html#LengthClampedInputStream-java.io.InputStream-int-">LengthClampedInputStream(InputStream, int)</a></span> - Constructor for class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/LengthClampedInputStream.html" title="class in com.captainalm.lib.calmnet.stream">LengthClampedInputStream</a></dt>
<dd>
<div class="block">Creates a LengthClampedInputStream with the specified <code>InputStream</code>
and the maximum number of bytes that can be read from the stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#loadKeyStore-java.lang.String-java.io.File-java.lang.String-">loadKeyStore(String, File, String)</a></span> - Static method in class com.captainalm.lib.calmnet.ssl.<a href="../com/captainalm/lib/calmnet/ssl/SSLUtilities.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilities</a></dt>
<dd>
<div class="block">Loads a Keystore of a certain type from a file given the password.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#loadPayload-byte:A-">loadPayload(byte[])</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core">Base64Packet</a></dt>
<dd>
<div class="block">Loads the packet payload from save data.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#loadPayload-byte:A-">loadPayload(byte[])</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></dt>
<dd>
<div class="block">Loads the packet payload from save data.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html#loadPayload-byte:A-">loadPayload(byte[])</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionCipherPacket</a></dt>
<dd>
<div class="block">Loads the packet payload from save data.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#loadPayload-byte:A-">loadPayload(byte[])</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionUpgradePacket</a></dt>
<dd>
<div class="block">Loads the packet payload from save data.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html#loadPayload-byte:A-">loadPayload(byte[])</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkIdentifierPacket</a></dt>
<dd>
<div class="block">Loads the packet payload from save data.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html#loadPayload-byte:A-">loadPayload(byte[])</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkSSLUpgradePacket</a></dt>
<dd>
<div class="block">Loads the packet payload from save data.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html#loadPayload-byte:A-">loadPayload(byte[])</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentAllocatePacket</a></dt>
<dd>
<div class="block">Loads the packet payload from save data.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html#loadPayload-byte:A-">loadPayload(byte[])</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentAllocationPacket</a></dt>
<dd>
<div class="block">Loads the packet payload from save data.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html#loadPayload-byte:A-">loadPayload(byte[])</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDAKNPacket</a></dt>
<dd>
<div class="block">Loads the packet payload from save data.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html#loadPayload-byte:A-">loadPayload(byte[])</a></span> - Method in 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></dt>
<dd>
<div class="block">Loads the packet payload from save data.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendStopPacket.html#loadPayload-byte:A-">loadPayload(byte[])</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendStopPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendStopPacket</a></dt>
<dd>
<div class="block">Loads the packet payload from save data.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendVerifyCompletePacket.html#loadPayload-byte:A-">loadPayload(byte[])</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendVerifyCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendVerifyCompletePacket</a></dt>
<dd>
<div class="block">Loads the packet payload from save data.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/IPacket.html#loadPayload-byte:A-">loadPayload(byte[])</a></span> - Method in 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></dt>
<dd>
<div class="block">Loads the packet payload from save data.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#localAddress--">localAddress()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Get the local <code>InetAddress</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#localAddress--">localAddress()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Get the local <code>InetAddress</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#localPort--">localPort()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Get the local port.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#localPort--">localPort()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Get the local port.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;</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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-9.html">Prev Letter</a></li>
<li><a href="index-11.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-10.html" target="_top">Frames</a></li>
<li><a href="index-10.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>

View File

@ -0,0 +1,137 @@
<!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:22 BST 2023 -->
<title>M-Index</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="M-Index";
}
}
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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-10.html">Prev Letter</a></li>
<li><a href="index-12.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-11.html" target="_top">Frames</a></li>
<li><a href="index-11.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="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;<a name="I:M">
<!-- -->
</a>
<h2 class="title">M</h2>
<dl>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/LengthClampedInputStream.html#mark-int-">mark(int)</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/LengthClampedInputStream.html" title="class in com.captainalm.lib.calmnet.stream">LengthClampedInputStream</a></dt>
<dd>
<div class="block">Marks the current position in this input stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/CandidateClient.html#matchesNetMarshalClient-com.captainalm.lib.calmnet.marshal.NetMarshalClient-">matchesNetMarshalClient(NetMarshalClient)</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/CandidateClient.html" title="class in com.captainalm.lib.calmnet.marshal">CandidateClient</a></dt>
<dd>
<div class="block">Checks if this candidate matches an existing <a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal"><code>NetMarshalClient</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#maximumFragmentAge">maximumFragmentAge</a></span> - Variable in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a></dt>
<dd>
<div class="block">The maximum age of fragments for a specified packet in seconds before those fragments are purged.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;</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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-10.html">Prev Letter</a></li>
<li><a href="index-12.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-11.html" target="_top">Frames</a></li>
<li><a href="index-11.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>

View File

@ -0,0 +1,259 @@
<!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:22 BST 2023 -->
<title>N-Index</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="N-Index";
}
}
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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-11.html">Prev Letter</a></li>
<li><a href="index-13.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-12.html" target="_top">Frames</a></li>
<li><a href="index-12.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="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;<a name="I:N">
<!-- -->
</a>
<h2 class="title">N</h2>
<dl>
<dt><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">NetMarshalClient</span></a> - Class in <a href="../com/captainalm/lib/calmnet/marshal/package-summary.html">com.captainalm.lib.calmnet.marshal</a></dt>
<dd>
<div class="block">This class provides a managed way of networking on the client side.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#NetMarshalClient-java.net.Socket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-">NetMarshalClient(Socket, IPacketFactory, PacketLoader, FragmentationOptions)</a></span> - Constructor for class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Constructs a new NetMarshalClient with the specified <code>Socket</code>, <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#NetMarshalClient-java.net.MulticastSocket-java.net.InetAddress-int-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-">NetMarshalClient(MulticastSocket, InetAddress, int, IPacketFactory, PacketLoader, FragmentationOptions)</a></span> - Constructor for class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Constructs a new NetMarshalClient with the specified <code>MulticastSocket</code>, multicast group <code>InetAddress</code>, multicast port, <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#NetMarshalClient-java.net.DatagramSocket-java.net.InetAddress-int-java.io.InputStream-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-">NetMarshalClient(DatagramSocket, InetAddress, int, InputStream, IPacketFactory, PacketLoader, FragmentationOptions)</a></span> - Constructor for class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Constructs a new NetMarshalClient with the specified <code>DatagramSocket</code>, remote <code>InetAddress</code>, remote port, <code>InputStream</code>, <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#NetMarshalClient-java.net.DatagramSocket-java.net.InetAddress-int-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-">NetMarshalClient(DatagramSocket, InetAddress, int, IPacketFactory, PacketLoader, FragmentationOptions)</a></span> - Constructor for class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Constructs a new NetMarshalClient with the specified <code>DatagramSocket</code>, remote <code>InetAddress</code>, remote port, <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClientWrapped.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">NetMarshalClientWrapped</span></a> - Class in <a href="../com/captainalm/lib/calmnet/marshal/package-summary.html">com.captainalm.lib.calmnet.marshal</a></dt>
<dd>
<div class="block">This class provides a managed way of networking on the client side, allows stream wrapping.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClientWrapped.html#NetMarshalClientWrapped-java.net.Socket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-java.util.function.Function-java.util.function.Function-">NetMarshalClientWrapped(Socket, IPacketFactory, PacketLoader, FragmentationOptions, Function&lt;InputStream, InputStream&gt;, Function&lt;OutputStream, OutputStream&gt;)</a></span> - Constructor for class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClientWrapped.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClientWrapped</a></dt>
<dd>
<div class="block">Constructs a new NetMarshalClientWrapped with the specified <code>Socket</code>, <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>,
<a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>, <code>Function</code> for wrapping the input stream and the <code>Function</code> for wrapping the output stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClientWrapped.html#NetMarshalClientWrapped-java.net.MulticastSocket-java.net.InetAddress-int-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-java.util.function.Function-java.util.function.Function-">NetMarshalClientWrapped(MulticastSocket, InetAddress, int, IPacketFactory, PacketLoader, FragmentationOptions, Function&lt;InputStream, InputStream&gt;, Function&lt;OutputStream, OutputStream&gt;)</a></span> - Constructor for class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClientWrapped.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClientWrapped</a></dt>
<dd>
<div class="block">Constructs a new NetMarshalClientWrapped with the specified <code>MulticastSocket</code>, multicast group <code>InetAddress</code>, multicast port, <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>,
<a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>, <code>Function</code> for wrapping the input stream and the <code>Function</code> for wrapping the output stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClientWrapped.html#NetMarshalClientWrapped-java.net.DatagramSocket-java.net.InetAddress-int-java.io.InputStream-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-java.util.function.Function-java.util.function.Function-">NetMarshalClientWrapped(DatagramSocket, InetAddress, int, InputStream, IPacketFactory, PacketLoader, FragmentationOptions, Function&lt;InputStream, InputStream&gt;, Function&lt;OutputStream, OutputStream&gt;)</a></span> - Constructor for class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClientWrapped.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClientWrapped</a></dt>
<dd>
<div class="block">Constructs a new NetMarshalClientWrapped with the specified <code>DatagramSocket</code>, remote <code>InetAddress</code>, remote port, <code>InputStream</code>, <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>,
<a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>, <code>Function</code> for wrapping the input stream and the <code>Function</code> for wrapping the output stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClientWrapped.html#NetMarshalClientWrapped-java.net.DatagramSocket-java.net.InetAddress-int-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-java.util.function.Function-java.util.function.Function-">NetMarshalClientWrapped(DatagramSocket, InetAddress, int, IPacketFactory, PacketLoader, FragmentationOptions, Function&lt;InputStream, InputStream&gt;, Function&lt;OutputStream, OutputStream&gt;)</a></span> - Constructor for class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClientWrapped.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClientWrapped</a></dt>
<dd>
<div class="block">Constructs a new NetMarshalClientWrapped with the specified <code>DatagramSocket</code>, remote <code>InetAddress</code>, remote port, <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>,
<a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>, <code>Function</code> for wrapping the input stream and the <code>Function</code> for wrapping the output stream.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">NetMarshalServer</span></a> - Class in <a href="../com/captainalm/lib/calmnet/marshal/package-summary.html">com.captainalm.lib.calmnet.marshal</a></dt>
<dd>
<div class="block">This class provides a way of networking on the server side and holds a collection of <a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal"><code>NetMarshalClient</code></a>s.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#NetMarshalServer-java.net.ServerSocket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-">NetMarshalServer(ServerSocket, IPacketFactory, PacketLoader, FragmentationOptions)</a></span> - Constructor for class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Constructs a new NetMarshalServer with the specified <code>ServerSocket</code>, <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#NetMarshalServer-java.net.DatagramSocket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-">NetMarshalServer(DatagramSocket, IPacketFactory, PacketLoader, FragmentationOptions)</a></span> - Constructor for class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Constructs a new NetMarshalServer with the specified <code>DatagramSocket</code>, <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <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/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServerWrapped.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">NetMarshalServerWrapped</span></a> - Class in <a href="../com/captainalm/lib/calmnet/marshal/package-summary.html">com.captainalm.lib.calmnet.marshal</a></dt>
<dd>
<div class="block">This class provides a way of networking on the server side and holds a collection of <a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal"><code>NetMarshalClient</code></a>s, allows stream wrapping.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServerWrapped.html#NetMarshalServerWrapped-java.net.ServerSocket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-java.util.function.Function-java.util.function.Function-">NetMarshalServerWrapped(ServerSocket, IPacketFactory, PacketLoader, FragmentationOptions, Function&lt;InputStream, InputStream&gt;, Function&lt;OutputStream, OutputStream&gt;)</a></span> - Constructor for class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServerWrapped.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServerWrapped</a></dt>
<dd>
<div class="block">Constructs a new NetMarshalServerWrapped with the specified <code>ServerSocket</code>, <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>,
<code>Function</code> for wrapping the input stream and the <code>Function</code> for wrapping the output stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServerWrapped.html#NetMarshalServerWrapped-java.net.DatagramSocket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.marshal.FragmentationOptions-java.util.function.Function-java.util.function.Function-">NetMarshalServerWrapped(DatagramSocket, IPacketFactory, PacketLoader, FragmentationOptions, Function&lt;InputStream, InputStream&gt;, Function&lt;OutputStream, OutputStream&gt;)</a></span> - Constructor for class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServerWrapped.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServerWrapped</a></dt>
<dd>
<div class="block">Constructs a new NetMarshalServerWrapped with the specified <code>DatagramSocket</code>, <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a>,
<code>Function</code> for wrapping the input stream and the <code>Function</code> for wrapping the output stream.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">NetworkEncryptionCipherPacket</span></a> - Class in <a href="../com/captainalm/lib/calmnet/packet/core/package-summary.html">com.captainalm.lib.calmnet.packet.core</a></dt>
<dd>
<div class="block">This class provides the ability for supporting streams to negotiate a cipher.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html#NetworkEncryptionCipherPacket-java.lang.Boolean-java.lang.String:A-">NetworkEncryptionCipherPacket(Boolean, String[])</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionCipherPacket</a></dt>
<dd>
<div class="block">Constructs a new instance of NetworkEncryptionCipherPacket with the specified acknowledgement value and the specified ciphers.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">NetworkEncryptionUpgradePacket</span></a> - Class in <a href="../com/captainalm/lib/calmnet/packet/core/package-summary.html">com.captainalm.lib.calmnet.packet.core</a></dt>
<dd>
<div class="block">This class provides the ability for supporting streams to upgrade to using password encrypted and / or base64 connections.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#NetworkEncryptionUpgradePacket-java.lang.Boolean-boolean-boolean-com.captainalm.lib.stdcrypt.encryption.ICipherFactory-">NetworkEncryptionUpgradePacket(Boolean, boolean, boolean, ICipherFactory)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionUpgradePacket</a></dt>
<dd>
<div class="block">Constructs a new NetworkEncryptionUpgradePacket with the specified acknowledgement value, upgrade value, base 64 value and <code>ICipherFactory</code>.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">NetworkIdentifierPacket</span></a> - Class in <a href="../com/captainalm/lib/calmnet/packet/core/package-summary.html">com.captainalm.lib.calmnet.packet.core</a></dt>
<dd>
<div class="block">This class provides a packet that is used to identify the type of network client is using this library.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html#NetworkIdentifierPacket-java.lang.String-">NetworkIdentifierPacket(String)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkIdentifierPacket</a></dt>
<dd>
<div class="block">Constructs a new instance of NetworkIdentifierPacket with the specified ID.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream"><span class="typeNameLink">NetworkInputStream</span></a> - Class in <a href="../com/captainalm/lib/calmnet/stream/package-summary.html">com.captainalm.lib.calmnet.stream</a></dt>
<dd>
<div class="block">This class provides a Network Input stream for either <code>Socket</code>s or <code>DatagramSocket</code>s.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#NetworkInputStream-java.net.Socket-">NetworkInputStream(Socket)</a></span> - Constructor for class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkInputStream</a></dt>
<dd>
<div class="block">Constructs a new NetworkInputStream with the specified <code>Socket</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#NetworkInputStream-java.net.DatagramSocket-">NetworkInputStream(DatagramSocket)</a></span> - Constructor for class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkInputStream</a></dt>
<dd>
<div class="block">Constructs a new NetworkInputStream with the specified <code>DatagramSocket</code>.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream"><span class="typeNameLink">NetworkOutputStream</span></a> - Class in <a href="../com/captainalm/lib/calmnet/stream/package-summary.html">com.captainalm.lib.calmnet.stream</a></dt>
<dd>
<div class="block">This class provides a Network Output stream for either <code>Socket</code>s or <code>DatagramSocket</code>s.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#NetworkOutputStream-java.net.Socket-">NetworkOutputStream(Socket)</a></span> - Constructor for class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkOutputStream</a></dt>
<dd>
<div class="block">Constructs a new NetworkOutputStream with the specified <code>Socket</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#NetworkOutputStream-java.net.DatagramSocket-">NetworkOutputStream(DatagramSocket)</a></span> - Constructor for class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkOutputStream</a></dt>
<dd>
<div class="block">Constructs a new NetworkOutputStream with the specified <code>DatagramSocket</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#NetworkOutputStream-java.net.DatagramSocket-int-">NetworkOutputStream(DatagramSocket, int)</a></span> - Constructor for class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkOutputStream</a></dt>
<dd>
<div class="block">Constructs a new NetworkOutputStream with the specified <code>DatagramSocket</code> and datagram buffer size.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#NetworkOutputStream-java.net.DatagramSocket-int-java.net.InetAddress-int-">NetworkOutputStream(DatagramSocket, int, InetAddress, int)</a></span> - Constructor for class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkOutputStream</a></dt>
<dd>
<div class="block">Constructs a new NetworkOutputStream with the specified <code>DatagramSocket</code>, datagram buffer size, <code>InetAddress</code> target and port target.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">NetworkSSLUpgradePacket</span></a> - Class in <a href="../com/captainalm/lib/calmnet/packet/core/package-summary.html">com.captainalm.lib.calmnet.packet.core</a></dt>
<dd>
<div class="block">This class provides the ability for supporting streams to upgrade to using SSL connections.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html#NetworkSSLUpgradePacket-java.lang.Boolean-">NetworkSSLUpgradePacket(Boolean)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkSSLUpgradePacket</a></dt>
<dd>
<div class="block">Constructs a new NetworkSSLUpgrade packet with the specified acknowledgement value.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;</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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-11.html">Prev Letter</a></li>
<li><a href="index-13.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-12.html" target="_top">Frames</a></li>
<li><a href="index-12.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>

View File

@ -0,0 +1,133 @@
<!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:22 BST 2023 -->
<title>O-Index</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="O-Index";
}
}
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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-12.html">Prev Letter</a></li>
<li><a href="index-14.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-13.html" target="_top">Frames</a></li>
<li><a href="index-13.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="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;<a name="I:O">
<!-- -->
</a>
<h2 class="title">O</h2>
<dl>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#open--">open()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Opens the marshal.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#open--">open()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Opens the marshal.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;</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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-12.html">Prev Letter</a></li>
<li><a href="index-14.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-13.html" target="_top">Frames</a></li>
<li><a href="index-13.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>

View File

@ -0,0 +1,181 @@
<!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:22 BST 2023 -->
<title>P-Index</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="P-Index";
}
}
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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-13.html">Prev Letter</a></li>
<li><a href="index-15.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-14.html" target="_top">Frames</a></li>
<li><a href="index-14.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="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;<a name="I:P">
<!-- -->
</a>
<h2 class="title">P</h2>
<dl>
<dt><a href="../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">PacketException</span></a> - Exception in <a href="../com/captainalm/lib/calmnet/packet/package-summary.html">com.captainalm.lib.calmnet.packet</a></dt>
<dd>
<div class="block">This class provides the packet exception wrapper class.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketException.html#PacketException-java.lang.String-">PacketException(String)</a></span> - Constructor for exception com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></dt>
<dd>
<div class="block">Constructs a new exception with the specified detail message.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketException.html#PacketException-java.lang.String-java.lang.Throwable-">PacketException(String, Throwable)</a></span> - Constructor for exception com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></dt>
<dd>
<div class="block">Constructs a new exception with the specified detail message and
cause.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketException.html#PacketException-java.lang.Throwable-">PacketException(Throwable)</a></span> - Constructor for exception com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></dt>
<dd>
<div class="block">Constructs a new exception with the specified cause and a detail
message of <tt>(cause==null ? null : cause.toString())</tt> (which
typically contains the class and detail message of <tt>cause</tt>).</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">PacketLoader</span></a> - Class in <a href="../com/captainalm/lib/calmnet/packet/package-summary.html">com.captainalm.lib.calmnet.packet</a></dt>
<dd>
<div class="block">This class provides the ability to load and save <a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>
to <code>InputStream</code> and <code>OutputStream</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html#PacketLoader--">PacketLoader()</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a></dt>
<dd>
<div class="block">Constructs a new Packet loader instance.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html#PacketLoader-com.captainalm.lib.stdcrypt.digest.DigestProvider-">PacketLoader(DigestProvider)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a></dt>
<dd>
<div class="block">Constructs a new Packet loader instance with the specified <code>DigestProvider</code>.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">PacketProtocolInformation</span></a> - Class in <a href="../com/captainalm/lib/calmnet/packet/package-summary.html">com.captainalm.lib.calmnet.packet</a></dt>
<dd>
<div class="block">This class provides the packet protocol information for <a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html#PacketProtocolInformation--">PacketProtocolInformation()</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a></dt>
<dd>
<div class="block">Constructs a new instance of PacketProtocolInformation.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html#PacketProtocolInformation-byte-byte-">PacketProtocolInformation(byte, byte)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a></dt>
<dd>
<div class="block">Constructs a new instance of PacketProtocolInformation.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#pollLastIDFinished--">pollLastIDFinished()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></dt>
<dd>
<div class="block">Polls the last finished packet ID.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#pollLastIDFinished--">pollLastIDFinished()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a></dt>
<dd>
<div class="block">Polls the last finished packet ID.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/CandidateClient.html#port">port</a></span> - Variable in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/CandidateClient.html" title="class in com.captainalm.lib.calmnet.marshal">CandidateClient</a></dt>
<dd>
<div class="block">The remote port of the candidate.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;</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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-13.html">Prev Letter</a></li>
<li><a href="index-15.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-14.html" target="_top">Frames</a></li>
<li><a href="index-14.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>

View File

@ -0,0 +1,231 @@
<!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:22 BST 2023 -->
<title>R-Index</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="R-Index";
}
}
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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-14.html">Prev Letter</a></li>
<li><a href="index-16.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-15.html" target="_top">Frames</a></li>
<li><a href="index-15.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="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;<a name="I:R">
<!-- -->
</a>
<h2 class="title">R</h2>
<dl>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/LengthClampedInputStream.html#read--">read()</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/LengthClampedInputStream.html" title="class in com.captainalm.lib.calmnet.stream">LengthClampedInputStream</a></dt>
<dd>
<div class="block">Reads the next byte of data from this input stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#read--">read()</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkInputStream</a></dt>
<dd>
<div class="block">Reads the next byte of data from the input stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html#readArrayFromInputStream-java.io.InputStream-int-">readArrayFromInputStream(InputStream, int)</a></span> - Static method in class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a></dt>
<dd>
<div class="block">Reads in a byte array of a specified length from an <code>InputStream</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html#readByteFromInputStream-java.io.InputStream-">readByteFromInputStream(InputStream)</a></span> - Static method in class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a></dt>
<dd>
<div class="block">Reads a byte from an <code>InputStream</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#readData-java.io.OutputStream-">readData(OutputStream)</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core">Base64Packet</a></dt>
<dd>
<div class="block">Reads payload data to an <code>OutputStream</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#readData-java.io.OutputStream-">readData(OutputStream)</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></dt>
<dd>
<div class="block">Reads payload data to an <code>OutputStream</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html#readData-java.io.OutputStream-">readData(OutputStream)</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionCipherPacket</a></dt>
<dd>
<div class="block">Reads payload data to an <code>OutputStream</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/IStreamedPacket.html#readData-java.io.OutputStream-">readData(OutputStream)</a></span> - Method in interface com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</a></dt>
<dd>
<div class="block">Reads payload data to an <code>OutputStream</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html#readInteger-java.io.InputStream-">readInteger(InputStream)</a></span> - Static method in class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a></dt>
<dd>
<div class="block">Reads an Integer from an <code>InputStream</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html#readPacket-java.io.InputStream-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">readPacket(InputStream, IPacketFactory, PacketProtocolInformation)</a></span> - Method in class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a></dt>
<dd>
<div class="block">Reads a <a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> from an input stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#readPacket--">readPacket()</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkInputStream</a></dt>
<dd>
<div class="block">Reads a single datagram packet.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#readPacket-byte:A-">readPacket(byte[])</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkInputStream</a></dt>
<dd>
<div class="block">Reads a single datagram packet into the specified buffer storing with no offset.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#readPacket-byte:A-int-int-">readPacket(byte[], int, int)</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkInputStream</a></dt>
<dd>
<div class="block">Reads a single datagram packet into the specified buffer
storing from the specified offset and the specified number of bytes.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html#readPacketNoDigest-byte:A-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">readPacketNoDigest(byte[], IPacketFactory, PacketProtocolInformation)</a></span> - Method in class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a></dt>
<dd>
<div class="block">Reads a <a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> from a byte array (No digest support).</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html#readPacketNoDigest-java.io.InputStream-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">readPacketNoDigest(InputStream, IPacketFactory, PacketProtocolInformation)</a></span> - Method in class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a></dt>
<dd>
<div class="block">Reads a <a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> from an input stream (No digest support).</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html#readStreamedPacket-java.io.InputStream-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">readStreamedPacket(InputStream, IPacketFactory, PacketProtocolInformation)</a></span> - Method in class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a></dt>
<dd>
<div class="block">Reads a <a href="../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a> from an input stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html#readStreamedPacketNoDigest-java.io.InputStream-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">readStreamedPacketNoDigest(InputStream, IPacketFactory, PacketProtocolInformation)</a></span> - Method in class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a></dt>
<dd>
<div class="block">Reads a <a href="../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a> from an input stream (No digest support).</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#receivePacket--">receivePacket()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<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>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#receivePacket--">receivePacket()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#receivePacket-com.captainalm.lib.calmnet.packet.IPacket-">receivePacket(IPacket)</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#receivePacket-com.captainalm.lib.calmnet.packet.IPacket-">receivePacket(IPacket)</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a></dt>
<dd>
<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 FragmentSender.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#receivePacketPolled--">receivePacketPolled()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<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> polled.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#receivePacketPolling--">receivePacketPolling()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#remoteAddress--">remoteAddress()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Get the remote <code>InetAddress</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#remotePort--">remotePort()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Get the remote port.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/LengthClampedInputStream.html#reset--">reset()</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/LengthClampedInputStream.html" title="class in com.captainalm.lib.calmnet.stream">LengthClampedInputStream</a></dt>
<dd>
<div class="block">Repositions this stream to the position at the time the
<code>mark</code> method was last called on this input stream.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;</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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-14.html">Prev Letter</a></li>
<li><a href="index-16.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-15.html" target="_top">Frames</a></li>
<li><a href="index-15.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>

View File

@ -0,0 +1,481 @@
<!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:22 BST 2023 -->
<title>S-Index</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="S-Index";
}
}
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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-15.html">Prev Letter</a></li>
<li><a href="index-17.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-16.html" target="_top">Frames</a></li>
<li><a href="index-16.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="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;<a name="I:S">
<!-- -->
</a>
<h2 class="title">S</h2>
<dl>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html#savePacketProtocolInformation-java.io.OutputStream-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">savePacketProtocolInformation(OutputStream, PacketProtocolInformation)</a></span> - Static method in class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a></dt>
<dd>
<div class="block">Saves the <a href="../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketProtocolInformation</code></a> of the packet.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#savePayload--">savePayload()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core">Base64Packet</a></dt>
<dd>
<div class="block">Saves the packet payload to a byte array.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#savePayload--">savePayload()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></dt>
<dd>
<div class="block">Saves the packet payload to a byte array.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html#savePayload--">savePayload()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionCipherPacket</a></dt>
<dd>
<div class="block">Saves the packet payload to a byte array.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#savePayload--">savePayload()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionUpgradePacket</a></dt>
<dd>
<div class="block">Saves the packet payload to a byte array.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html#savePayload--">savePayload()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkIdentifierPacket</a></dt>
<dd>
<div class="block">Saves the packet payload to a byte array.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html#savePayload--">savePayload()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkSSLUpgradePacket</a></dt>
<dd>
<div class="block">Saves the packet payload to a byte array.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html#savePayload--">savePayload()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentAllocatePacket</a></dt>
<dd>
<div class="block">Saves the packet payload to a byte array.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html#savePayload--">savePayload()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentAllocationPacket</a></dt>
<dd>
<div class="block">Saves the packet payload to a byte array.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html#savePayload--">savePayload()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentMessagePacket</a></dt>
<dd>
<div class="block">Saves the packet payload to a byte array.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html#savePayload--">savePayload()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDAKNPacket</a></dt>
<dd>
<div class="block">Saves the packet payload to a byte array.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html#savePayload--">savePayload()</a></span> - Method in 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></dt>
<dd>
<div class="block">Saves the packet payload to a byte array.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendStopPacket.html#savePayload--">savePayload()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendStopPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendStopPacket</a></dt>
<dd>
<div class="block">Saves the packet payload to a byte array.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendVerifyCompletePacket.html#savePayload--">savePayload()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendVerifyCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendVerifyCompletePacket</a></dt>
<dd>
<div class="block">Saves the packet payload to a byte array.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/IPacket.html#savePayload--">savePayload()</a></span> - Method in 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></dt>
<dd>
<div class="block">Saves the packet payload to a byte array.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#sendPacket-com.captainalm.lib.calmnet.packet.IPacket-boolean-">sendPacket(IPacket, boolean)</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Sends a <a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#sendPacket--">sendPacket()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#sendPacket-com.captainalm.lib.calmnet.packet.IPacket-">sendPacket(IPacket)</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a></dt>
<dd>
<div class="block">Sends a <a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> using this FragmentSender.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#sendPacket--">sendPacket()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a></dt>
<dd>
<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 FragmentSender.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#setAcceptExceptionBiConsumer-java.util.function.BiConsumer-">setAcceptExceptionBiConsumer(BiConsumer&lt;Exception, NetMarshalServer&gt;)</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Sets the <code>BiConsumer</code> accept exception consumer.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html#setAllowInvalidPackets-boolean-">setAllowInvalidPackets(boolean)</a></span> - Method in class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a></dt>
<dd>
<div class="block">This sets whether invalid packets are allowed to be read and written.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#setBase64ed-boolean-">setBase64ed(boolean)</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionUpgradePacket</a></dt>
<dd>
<div class="block">Sets if base64 is used.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#setCacheUsed-boolean-">setCacheUsed(boolean)</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core">Base64Packet</a></dt>
<dd>
<div class="block">Sets if the encrypted data is cached.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#setCacheUsed-boolean-">setCacheUsed(boolean)</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></dt>
<dd>
<div class="block">Sets if the encrypted data is cached.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html#setCacheUsed-boolean-">setCacheUsed(boolean)</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionCipherPacket</a></dt>
<dd>
<div class="block">Sets if the cipher information is cached.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/IInternalCache.html#setCacheUsed-boolean-">setCacheUsed(boolean)</a></span> - Method in interface com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/IInternalCache.html" title="interface in com.captainalm.lib.calmnet.packet">IInternalCache</a></dt>
<dd>
<div class="block">Sets if the internal cache is used.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#setCipherFactory-com.captainalm.lib.stdcrypt.encryption.ICipherFactory-">setCipherFactory(ICipherFactory)</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></dt>
<dd>
<div class="block">Sets the <code>ICipherFactory</code> being used.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#setCipherFactory-com.captainalm.lib.stdcrypt.encryption.ICipherFactory-">setCipherFactory(ICipherFactory)</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionUpgradePacket</a></dt>
<dd>
<div class="block">Sets the <code>ICipherFactory</code> being used.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#setCipherFactory-com.captainalm.lib.stdcrypt.encryption.ICipherFactory-">setCipherFactory(ICipherFactory)</a></span> - Method in class com.captainalm.lib.calmnet.packet.factory.<a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactory</a></dt>
<dd>
<div class="block">Sets the <code>ICipherFactory</code> in use.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html#setCiphers-java.lang.String:A-">setCiphers(String[])</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionCipherPacket</a></dt>
<dd>
<div class="block">Sets the cipher names this packet contains.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/LengthClampedInputStream.html#setClampedLength-int-">setClampedLength(int)</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/LengthClampedInputStream.html" title="class in com.captainalm.lib.calmnet.stream">LengthClampedInputStream</a></dt>
<dd>
<div class="block">Sets a new clamped length value.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#setClientAcceptanceBiConsumer-java.util.function.BiConsumer-">setClientAcceptanceBiConsumer(BiConsumer&lt;CandidateClient, NetMarshalServer&gt;)</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Sets the <code>BiConsumer</code> client acceptance consumer.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#setClosedConsumer-java.util.function.Consumer-">setClosedConsumer(Consumer&lt;NetMarshalClient&gt;)</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Sets the <code>Consumer</code> closed consumer.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#setClosedConsumer-java.util.function.Consumer-">setClosedConsumer(Consumer&lt;NetMarshalClient&gt;)</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Sets the <code>Consumer</code> closed consumer.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#setDatagramBufferSize-int-">setDatagramBufferSize(int)</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkOutputStream</a></dt>
<dd>
<div class="block">Sets the buffer size for sending datagrams.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#setDatagramSocket-java.net.DatagramSocket-">setDatagramSocket(DatagramSocket)</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkInputStream</a></dt>
<dd>
<div class="block">Sets the datagram socket in use.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#setDatagramSocket-java.net.DatagramSocket-">setDatagramSocket(DatagramSocket)</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkOutputStream</a></dt>
<dd>
<div class="block">Sets the datagram socket in use.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#setDatagramTarget-java.net.InetAddress-int-">setDatagramTarget(InetAddress, int)</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkOutputStream</a></dt>
<dd>
<div class="block">Sets the datagram target <code>InetAddress</code> and port.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#setFactory-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-">setFactory(IPacketFactory)</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core">Base64Packet</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#setFactory-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-">setFactory(IPacketFactory)</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#setHeldPacket-com.captainalm.lib.calmnet.packet.IPacket-">setHeldPacket(IPacket)</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core">Base64Packet</a></dt>
<dd>
<div class="block">Sets the held packet.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#setHeldPacket-com.captainalm.lib.calmnet.packet.IPacket-">setHeldPacket(IPacket)</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></dt>
<dd>
<div class="block">Sets the held packet.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#setIfSecretsSent-boolean-">setIfSecretsSent(boolean)</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionUpgradePacket</a></dt>
<dd>
<div class="block">Sets if secrets should be sent as part of cipher settings.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setNumberOfEmptySendsTillForcedCompleteOrResend-int-">setNumberOfEmptySendsTillForcedCompleteOrResend(int)</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></dt>
<dd>
<div class="block">Sets the number of <a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#sendPacket--"><code>FragmentReceiver.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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#setOpenedConsumer-java.util.function.Consumer-">setOpenedConsumer(Consumer&lt;NetMarshalClient&gt;)</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Sets the <code>Consumer</code> opened consumer.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactoryWithPacket.html#setPacket-com.captainalm.lib.calmnet.packet.IPacket-">setPacket(IPacket)</a></span> - Method in class com.captainalm.lib.calmnet.packet.factory.<a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactoryWithPacket.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactoryWithPacket</a></dt>
<dd>
<div class="block">Sets the <a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> in use.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#setPacketFactory-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-">setPacketFactory(IPacketFactory)</a></span> - Method in class com.captainalm.lib.calmnet.packet.factory.<a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactory</a></dt>
<dd>
<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> in use (null signifies to use the same instance).</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setPacketFactory-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-">setPacketFactory(IPacketFactory)</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#setPacketLoader-com.captainalm.lib.calmnet.packet.PacketLoader-">setPacketLoader(PacketLoader)</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core">Base64Packet</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#setPacketLoader-com.captainalm.lib.calmnet.packet.PacketLoader-">setPacketLoader(PacketLoader)</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#setPacketLoader-com.captainalm.lib.calmnet.packet.PacketLoader-">setPacketLoader(PacketLoader)</a></span> - Method in class com.captainalm.lib.calmnet.packet.factory.<a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactory</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setPacketLoader-com.captainalm.lib.calmnet.packet.PacketLoader-">setPacketLoader(PacketLoader)</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#setPacketLoader-com.captainalm.lib.calmnet.packet.PacketLoader-">setPacketLoader(PacketLoader)</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#setPacketsShouldBeRead-boolean-">setPacketsShouldBeRead(boolean)</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Set if <a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>s should be read.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#setReceiveBiConsumer-java.util.function.BiConsumer-">setReceiveBiConsumer(BiConsumer&lt;IPacket, NetMarshalClient&gt;)</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Sets the <code>BiConsumer</code> receiver consumer.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#setReceiveBiConsumer-java.util.function.BiConsumer-">setReceiveBiConsumer(BiConsumer&lt;IPacket, NetMarshalClient&gt;)</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Sets the <code>BiConsumer</code> receiver consumer.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#setReceiveExceptionBiConsumer-java.util.function.BiConsumer-">setReceiveExceptionBiConsumer(BiConsumer&lt;Exception, NetMarshalClient&gt;)</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Sets the <code>BiConsumer</code> receive exception consumer.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#setReceiveExceptionBiConsumer-java.util.function.BiConsumer-">setReceiveExceptionBiConsumer(BiConsumer&lt;Exception, NetMarshalClient&gt;)</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Sets the <code>BiConsumer</code> receive exception consumer.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setResponseVerification-boolean-">setResponseVerification(boolean)</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></dt>
<dd>
<div class="block">Sets whether responses should be verified.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#setResponseVerification-boolean-">setResponseVerification(boolean)</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a></dt>
<dd>
<div class="block">Sets whether responses should be verified.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setSentDataWillBeAllVerified-boolean-">setSentDataWillBeAllVerified(boolean)</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></dt>
<dd>
<div class="block">Gets whether all sent fragments are verified to be equal.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#setSentDataWillBeAllVerified-boolean-">setSentDataWillBeAllVerified(boolean)</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a></dt>
<dd>
<div class="block">Gets whether all sent fragments are verified to be equal.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#setSocket-java.net.Socket-">setSocket(Socket)</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkInputStream</a></dt>
<dd>
<div class="block">Sets the socket in use.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#setSocket-java.net.Socket-">setSocket(Socket)</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkOutputStream</a></dt>
<dd>
<div class="block">Sets the socket in use.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#setSocketSetupBiConsumer-java.util.function.BiConsumer-">setSocketSetupBiConsumer(BiConsumer&lt;Socket, NetMarshalServer&gt;)</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Sets the <code>BiConsumer</code> socket setup consumer.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#setSplitSize-int-">setSplitSize(int)</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a></dt>
<dd>
<div class="block">Sets the packet split size in bytes.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#setStreamPacketsPreferred-boolean-">setStreamPacketsPreferred(boolean)</a></span> - Method in class com.captainalm.lib.calmnet.packet.factory.<a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactory</a></dt>
<dd>
<div class="block">Sets if <a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#getPacket-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-"><code>CALMNETPacketFactory.getPacket(PacketProtocolInformation)</code></a> prefers returning <a href="../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a>s if possible.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html#setStreamPacketsPreferred-boolean-">setStreamPacketsPreferred(boolean)</a></span> - Method in interface com.captainalm.lib.calmnet.packet.factory.<a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a></dt>
<dd>
<div class="block">Sets if <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html#getPacket-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-"><code>getPacket(PacketProtocolInformation)</code></a> prefers returning <a href="../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a>s if possible.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#setTrailingPassword-java.lang.String-">setTrailingPassword(String)</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></dt>
<dd>
<div class="block">Sets the trailing password (Use null for no trailing password).</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#setUpgrade-boolean-">setUpgrade(boolean)</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionUpgradePacket</a></dt>
<dd>
<div class="block">Sets if the packet is treated as a stream upgrade or
a change in packet use for <a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><code>EncryptedPacket</code></a> and <a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core"><code>Base64Packet</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#setupReceiver-com.captainalm.lib.calmnet.packet.fragment.FragmentReceiver-">setupReceiver(FragmentReceiver)</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a></dt>
<dd>
<div class="block">Sets-up the provided <a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentReceiver</code></a> with parameters.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#setupSender-com.captainalm.lib.calmnet.packet.fragment.FragmentSender-">setupSender(FragmentSender)</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a></dt>
<dd>
<div class="block">Sets-up the provided <a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentSender</code></a> with parameters.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#shouldSentDataBeAllVerified--">shouldSentDataBeAllVerified()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></dt>
<dd>
<div class="block">Gets whether all sent fragments are verified to be equal.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#shouldSentDataBeAllVerified--">shouldSentDataBeAllVerified()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a></dt>
<dd>
<div class="block">Gets whether all sent fragments are verified to be equal.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#shouldVerifyResponses--">shouldVerifyResponses()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></dt>
<dd>
<div class="block">Gets whether responses should be verified.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#shouldVerifyResponses--">shouldVerifyResponses()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a></dt>
<dd>
<div class="block">Gets whether responses should be verified.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#sslUpgradeClientSide-javax.net.ssl.SSLContext-java.lang.String-">sslUpgradeClientSide(SSLContext, String)</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Performs SSL socket upgrades on client side (Use for constructed sockets).</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#sslUpgradeServerSide-javax.net.ssl.SSLContext-">sslUpgradeServerSide(SSLContext)</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Performs SSL socket upgrades on server side (Use for accepted sockets).</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/ssl/SSLUtilities.html" title="class in com.captainalm.lib.calmnet.ssl"><span class="typeNameLink">SSLUtilities</span></a> - Class in <a href="../com/captainalm/lib/calmnet/ssl/package-summary.html">com.captainalm.lib.calmnet.ssl</a></dt>
<dd>
<div class="block">This class provides SSL utilities to create <code>SSLContext</code> and <code>SSLSocket</code>
objects using JKS files (Or other supported formats).</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#SSLUtilities--">SSLUtilities()</a></span> - Constructor for class com.captainalm.lib.calmnet.ssl.<a href="../com/captainalm/lib/calmnet/ssl/SSLUtilities.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilities</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl"><span class="typeNameLink">SSLUtilityException</span></a> - Exception in <a href="../com/captainalm/lib/calmnet/ssl/package-summary.html">com.captainalm.lib.calmnet.ssl</a></dt>
<dd>
<div class="block">This class provides the SSL Utility exception wrapper class.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html#SSLUtilityException-java.lang.String-">SSLUtilityException(String)</a></span> - Constructor for exception com.captainalm.lib.calmnet.ssl.<a href="../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></dt>
<dd>
<div class="block">Constructs a new exception with the specified detail message.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html#SSLUtilityException-java.lang.String-java.lang.Throwable-">SSLUtilityException(String, Throwable)</a></span> - Constructor for exception com.captainalm.lib.calmnet.ssl.<a href="../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></dt>
<dd>
<div class="block">Constructs a new exception with the specified detail message and
cause.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html#SSLUtilityException-java.lang.Throwable-">SSLUtilityException(Throwable)</a></span> - Constructor for exception com.captainalm.lib.calmnet.ssl.<a href="../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></dt>
<dd>
<div class="block">Constructs a new exception with the specified cause and a detail
message of <tt>(cause==null ? null : cause.toString())</tt> (which
typically contains the class and detail message of <tt>cause</tt>).</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#stopAllDataVerificationAndCompleteReceive--">stopAllDataVerificationAndCompleteReceive()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></dt>
<dd>
<div class="block">Stops data verification for all packets being received when <a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#shouldSentDataBeAllVerified--"><code>FragmentReceiver.shouldSentDataBeAllVerified()</code></a> is true.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#stopAllDataVerificationAndCompleteSend--">stopAllDataVerificationAndCompleteSend()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a></dt>
<dd>
<div class="block">Stops data verification for all packets being sent when <a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#shouldSentDataBeAllVerified--"><code>FragmentSender.shouldSentDataBeAllVerified()</code></a> is true.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#stopDataVerificationAndCompleteReceive-int-">stopDataVerificationAndCompleteReceive(int)</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></dt>
<dd>
<div class="block">Stops data verification for the specified Packet ID when <a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#shouldSentDataBeAllVerified--"><code>FragmentReceiver.shouldSentDataBeAllVerified()</code></a> is true.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#stopDataVerificationAndCompleteSend-int-">stopDataVerificationAndCompleteSend(int)</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a></dt>
<dd>
<div class="block">Stops data verification for the specified Packet ID when <a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#shouldSentDataBeAllVerified--"><code>FragmentSender.shouldSentDataBeAllVerified()</code></a> is true.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;</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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-15.html">Prev Letter</a></li>
<li><a href="index-17.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-16.html" target="_top">Frames</a></li>
<li><a href="index-16.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>

View File

@ -0,0 +1,135 @@
<!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:22 BST 2023 -->
<title>U-Index</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="U-Index";
}
}
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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-16.html">Prev Letter</a></li>
<li><a href="index-18.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-17.html" target="_top">Frames</a></li>
<li><a href="index-17.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="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;<a name="I:U">
<!-- -->
</a>
<h2 class="title">U</h2>
<dl>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#upgradeClientSocketToSSL-javax.net.ssl.SSLContext-java.net.Socket-java.lang.String-int-boolean-">upgradeClientSocketToSSL(SSLContext, Socket, String, int, boolean)</a></span> - Static method in class com.captainalm.lib.calmnet.ssl.<a href="../com/captainalm/lib/calmnet/ssl/SSLUtilities.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilities</a></dt>
<dd>
<div class="block">Upgrades an existing <code>Socket</code> to an <code>SSLSocket</code> using the specified <code>SSLContext</code>,
<code>Socket</code>, host, port and if the specified socket should be closed when the returned socket is closed.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#upgradeClientSocketToSSL-javax.net.ssl.SSLContext-java.net.Socket-java.lang.String-int-boolean-boolean-">upgradeClientSocketToSSL(SSLContext, Socket, String, int, boolean, boolean)</a></span> - Static method in class com.captainalm.lib.calmnet.ssl.<a href="../com/captainalm/lib/calmnet/ssl/SSLUtilities.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilities</a></dt>
<dd>
<div class="block">Upgrades an existing <code>Socket</code> to an <code>SSLSocket</code> using the specified <code>SSLContext</code>,
<code>Socket</code>, host, port and if the specified socket should be closed when the returned socket is closed.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;</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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-16.html">Prev Letter</a></li>
<li><a href="index-18.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-17.html" target="_top">Frames</a></li>
<li><a href="index-17.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>

View File

@ -0,0 +1,135 @@
<!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:22 BST 2023 -->
<title>V-Index</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="V-Index";
}
}
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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-17.html">Prev Letter</a></li>
<li><a href="index-19.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-18.html" target="_top">Frames</a></li>
<li><a href="index-18.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="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;<a name="I:V">
<!-- -->
</a>
<h2 class="title">V</h2>
<dl>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#validate--">validate()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a></dt>
<dd>
<div class="block">Validates the parameters within this structure.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#verifyFragments">verifyFragments</a></span> - Variable in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a></dt>
<dd>
<div class="block">See:
<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#setResponseVerification-boolean-"><code>FragmentSender.setResponseVerification(boolean)</code></a> ,
<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setResponseVerification-boolean-"><code>FragmentReceiver.setResponseVerification(boolean)</code></a></div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;</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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-17.html">Prev Letter</a></li>
<li><a href="index-19.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-18.html" target="_top">Frames</a></li>
<li><a href="index-18.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>

View File

@ -0,0 +1,161 @@
<!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:22 BST 2023 -->
<title>W-Index</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="W-Index";
}
}
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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-18.html">Prev Letter</a></li>
<li>Next Letter</li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-19.html" target="_top">Frames</a></li>
<li><a href="index-19.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="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;<a name="I:W">
<!-- -->
</a>
<h2 class="title">W</h2>
<dl>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#write-int-">write(int)</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkOutputStream</a></dt>
<dd>
<div class="block">Writes the specified byte to this output stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#writeData-java.io.InputStream-int-">writeData(InputStream, int)</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core">Base64Packet</a></dt>
<dd>
<div class="block">Writes payload data from an <code>InputStream</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#writeData-java.io.InputStream-int-">writeData(InputStream, int)</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></dt>
<dd>
<div class="block">Writes payload data from an <code>InputStream</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html#writeData-java.io.InputStream-int-">writeData(InputStream, int)</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionCipherPacket</a></dt>
<dd>
<div class="block">Writes payload data from an <code>InputStream</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/IStreamedPacket.html#writeData-java.io.InputStream-int-">writeData(InputStream, int)</a></span> - Method in interface com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</a></dt>
<dd>
<div class="block">Writes payload data from an <code>InputStream</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html#writeInteger-java.io.OutputStream-int-">writeInteger(OutputStream, int)</a></span> - Static method in class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a></dt>
<dd>
<div class="block">Writes an Integer to the <code>OutputStream</code> using 4 bytes.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html#writePacket-java.io.OutputStream-com.captainalm.lib.calmnet.packet.IPacket-boolean-">writePacket(OutputStream, IPacket, boolean)</a></span> - Method in class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a></dt>
<dd>
<div class="block">Writes a <a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> to an output stream (No digest support).</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html#writePacketNoDigest-com.captainalm.lib.calmnet.packet.IPacket-boolean-">writePacketNoDigest(IPacket, boolean)</a></span> - Method in class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a></dt>
<dd>
<div class="block">Returns a <a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> to a byte array (No digest support).</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html#writePacketNoDigest-java.io.OutputStream-com.captainalm.lib.calmnet.packet.IPacket-boolean-">writePacketNoDigest(OutputStream, IPacket, boolean)</a></span> - Method in class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a></dt>
<dd>
<div class="block">Writes a <a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> to an output stream.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;</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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-18.html">Prev Letter</a></li>
<li>Next Letter</li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-19.html" target="_top">Frames</a></li>
<li><a href="index-19.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>

View File

@ -0,0 +1,151 @@
<!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:22 BST 2023 -->
<title>B-Index</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="B-Index";
}
}
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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-1.html">Prev Letter</a></li>
<li><a href="index-3.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-2.html" target="_top">Frames</a></li>
<li><a href="index-2.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="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;<a name="I:B">
<!-- -->
</a>
<h2 class="title">B</h2>
<dl>
<dt><a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">Base64Packet</span></a> - Class in <a href="../com/captainalm/lib/calmnet/packet/core/package-summary.html">com.captainalm.lib.calmnet.packet.core</a></dt>
<dd>
<div class="block">This class provides a base64 encrypted packet that can hold an <a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#Base64Packet-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-">Base64Packet(IPacketFactory, PacketLoader)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core">Base64Packet</a></dt>
<dd>
<div class="block">Constructs a new Base64Packet with the specified <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a> and <a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#Base64Packet-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-boolean-">Base64Packet(IPacketFactory, PacketLoader, boolean)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core">Base64Packet</a></dt>
<dd>
<div class="block">Constructs a new Base64Packet with the specified <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>
and if the encrypted data should be cached.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#Base64Packet-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.packet.IPacket-">Base64Packet(IPacketFactory, PacketLoader, IPacket)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core">Base64Packet</a></dt>
<dd>
<div class="block">Constructs a new Base64Packet with the specified <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <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/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#Base64Packet-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.packet.IPacket-boolean-">Base64Packet(IPacketFactory, PacketLoader, IPacket, boolean)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core">Base64Packet</a></dt>
<dd>
<div class="block">Constructs a new Base64Packet with the specified <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>,
<a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> and if the encrypted data should be cached.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#broadcastPacket-com.captainalm.lib.calmnet.packet.IPacket-boolean-">broadcastPacket(IPacket, boolean)</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Broadcasts a <a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;</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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-1.html">Prev Letter</a></li>
<li><a href="index-3.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-2.html" target="_top">Frames</a></li>
<li><a href="index-2.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>

View File

@ -0,0 +1,247 @@
<!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:22 BST 2023 -->
<title>C-Index</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="C-Index";
}
}
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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-2.html">Prev Letter</a></li>
<li><a href="index-4.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-3.html" target="_top">Frames</a></li>
<li><a href="index-3.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="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;<a name="I:C">
<!-- -->
</a>
<h2 class="title">C</h2>
<dl>
<dt><a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html" title="class in com.captainalm.lib.calmnet.packet.factory"><span class="typeNameLink">CALMNETPacketFactory</span></a> - Class in <a href="../com/captainalm/lib/calmnet/packet/factory/package-summary.html">com.captainalm.lib.calmnet.packet.factory</a></dt>
<dd>
<div class="block">This class provides a standard extensible <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a> for calmnet packets.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#CALMNETPacketFactory-boolean-com.captainalm.lib.calmnet.packet.PacketLoader-">CALMNETPacketFactory(boolean, PacketLoader)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.factory.<a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactory</a></dt>
<dd>
<div class="block">Constructs a new Instance of CALMNETPacketFactory with if <a href="../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a>s are preferred and the specified <a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#CALMNETPacketFactory-boolean-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-">CALMNETPacketFactory(boolean, PacketLoader, IPacketFactory)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.factory.<a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactory</a></dt>
<dd>
<div class="block">Constructs a new Instance of CALMNETPacketFactory with if <a href="../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a>s are preferred, the specified <a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a> and the <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactoryWithPacket.html" title="class in com.captainalm.lib.calmnet.packet.factory"><span class="typeNameLink">CALMNETPacketFactoryWithPacket</span></a> - Class in <a href="../com/captainalm/lib/calmnet/packet/factory/package-summary.html">com.captainalm.lib.calmnet.packet.factory</a></dt>
<dd>
<div class="block">This class provides a standard extensible <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a> for calmnet packets
with the ability to set the <a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> of supporting packets.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactoryWithPacket.html#CALMNETPacketFactoryWithPacket-boolean-com.captainalm.lib.calmnet.packet.PacketLoader-">CALMNETPacketFactoryWithPacket(boolean, PacketLoader)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.factory.<a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactoryWithPacket.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactoryWithPacket</a></dt>
<dd>
<div class="block">Constructs a new Instance of CALMNETPacketFactoryWithPacket with if <a href="../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a>s are preferred and the specified <a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactoryWithPacket.html#CALMNETPacketFactoryWithPacket-boolean-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-">CALMNETPacketFactoryWithPacket(boolean, PacketLoader, IPacketFactory)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.factory.<a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactoryWithPacket.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactoryWithPacket</a></dt>
<dd>
<div class="block">Constructs a new Instance of CALMNETPacketFactoryWithPacket with if <a href="../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IStreamedPacket</code></a>s are preferred, the specified <a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a> and the <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#canDatagramBufferBeSet--">canDatagramBufferBeSet()</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkOutputStream</a></dt>
<dd>
<div class="block">Gets if the <a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#setDatagramBufferSize-int-"><code>NetworkOutputStream.setDatagramBufferSize(int)</code></a> can be used.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/marshal/CandidateClient.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">CandidateClient</span></a> - Class in <a href="../com/captainalm/lib/calmnet/marshal/package-summary.html">com.captainalm.lib.calmnet.marshal</a></dt>
<dd>
<div class="block">This class provides a candidate client for <a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal"><code>NetMarshalServer</code></a>s.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/CandidateClient.html#CandidateClient-java.net.InetAddress-int-">CandidateClient(InetAddress, int)</a></span> - Constructor for class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/CandidateClient.html" title="class in com.captainalm.lib.calmnet.marshal">CandidateClient</a></dt>
<dd>
<div class="block">Constructs a new instance of CandidateClient with an address and port.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#clearFragmentStorage--">clearFragmentStorage()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Clears the fragment storage registries if fragmentation is enabled.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#clearLastIDFinished--">clearLastIDFinished()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></dt>
<dd>
<div class="block">Clears all the last finished packet IDs.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#clearLastIDFinished--">clearLastIDFinished()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a></dt>
<dd>
<div class="block">Clears all the last finished packet IDs.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#clearRegistry--">clearRegistry()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></dt>
<dd>
<div class="block">Clears the registry (And requests the sender to stop sending).</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#clearRegistry--">clearRegistry()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a></dt>
<dd>
<div class="block">Clears the registry.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#clearWaitingPackets--">clearWaitingPackets()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></dt>
<dd>
<div class="block">Clears the currently waiting packets.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#clearWaitingPackets--">clearWaitingPackets()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a></dt>
<dd>
<div class="block">Clears the currently waiting packets.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#close--">close()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Closes the marshal, closing all its streams.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#close--">close()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Closes the marshal, closing all the connected clients.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/LengthClampedInputStream.html#close--">close()</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/LengthClampedInputStream.html" title="class in com.captainalm.lib.calmnet.stream">LengthClampedInputStream</a></dt>
<dd>
<div class="block">Closes this input stream and releases any system resources
associated with the stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#close--">close()</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkInputStream</a></dt>
<dd>
<div class="block">Closes this input stream and releases any system resources associated
with the stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#close--">close()</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkOutputStream</a></dt>
<dd>
<div class="block">Closes this output stream and releases any system resources
associated with this stream.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/marshal/package-summary.html">com.captainalm.lib.calmnet.marshal</a> - package com.captainalm.lib.calmnet.marshal</dt>
<dd>
<div class="block">This package contains the network marshals for managed sending of <a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>s on sockets.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/package-summary.html">com.captainalm.lib.calmnet.packet</a> - package com.captainalm.lib.calmnet.packet</dt>
<dd>
<div class="block">This package contains the network packets and handling code.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/core/package-summary.html">com.captainalm.lib.calmnet.packet.core</a> - package com.captainalm.lib.calmnet.packet.core</dt>
<dd>
<div class="block">This package contains the core network packets.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/factory/package-summary.html">com.captainalm.lib.calmnet.packet.factory</a> - package com.captainalm.lib.calmnet.packet.factory</dt>
<dd>
<div class="block">This package contains the <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a> interface and standard classes.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/fragment/package-summary.html">com.captainalm.lib.calmnet.packet.fragment</a> - package com.captainalm.lib.calmnet.packet.fragment</dt>
<dd>
<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>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/ssl/package-summary.html">com.captainalm.lib.calmnet.ssl</a> - package com.captainalm.lib.calmnet.ssl</dt>
<dd>
<div class="block">This package provides SSL utilities for wrapping
<code>Socket</code>s and creating <code>SSLContext</code>s.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/stream/package-summary.html">com.captainalm.lib.calmnet.stream</a> - package com.captainalm.lib.calmnet.stream</dt>
<dd>
<div class="block">This package provides streams for network packet streaming.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#connect-java.net.InetAddress-int-int-">connect(InetAddress, int, int)</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Connects to a remote endpoint.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;</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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-2.html">Prev Letter</a></li>
<li><a href="index-4.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-3.html" target="_top">Frames</a></li>
<li><a href="index-3.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>

View File

@ -0,0 +1,137 @@
<!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:22 BST 2023 -->
<title>D-Index</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="D-Index";
}
}
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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-3.html">Prev Letter</a></li>
<li><a href="index-5.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-4.html" target="_top">Frames</a></li>
<li><a href="index-4.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="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;<a name="I:D">
<!-- -->
</a>
<h2 class="title">D</h2>
<dl>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#deletePacketFromRegistry-int-">deletePacketFromRegistry(int)</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></dt>
<dd>
<div class="block">Deletes a packet from the registry and requests the sender to stop sending.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#deletePacketFromRegistry-int-">deletePacketFromRegistry(int)</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a></dt>
<dd>
<div class="block">Deletes a packet from the registry.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#disconnectAll--">disconnectAll()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Disconnects all the clients (By closing them).</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;</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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-3.html">Prev Letter</a></li>
<li><a href="index-5.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-4.html" target="_top">Frames</a></li>
<li><a href="index-4.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>

View File

@ -0,0 +1,164 @@
<!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:22 BST 2023 -->
<title>E-Index</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="E-Index";
}
}
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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-4.html">Prev Letter</a></li>
<li><a href="index-6.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-5.html" target="_top">Frames</a></li>
<li><a href="index-5.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="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;<a name="I:E">
<!-- -->
</a>
<h2 class="title">E</h2>
<dl>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#emptySendsTillForced">emptySendsTillForced</a></span> - Variable in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a></dt>
<dd>
<div class="block">See:
<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setNumberOfEmptySendsTillForcedCompleteOrResend-int-"><code>FragmentReceiver.setNumberOfEmptySendsTillForcedCompleteOrResend(int)</code></a></div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">EncryptedPacket</span></a> - Class in <a href="../com/captainalm/lib/calmnet/packet/core/package-summary.html">com.captainalm.lib.calmnet.packet.core</a></dt>
<dd>
<div class="block">This class provides an encrypted packet that can hold an <a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#EncryptedPacket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.stdcrypt.encryption.ICipherFactory-">EncryptedPacket(IPacketFactory, PacketLoader, ICipherFactory)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></dt>
<dd>
<div class="block">Constructs a new EncryptedPacket with the specified <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a> and <code>ICipherFactory</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#EncryptedPacket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.stdcrypt.encryption.ICipherFactory-boolean-">EncryptedPacket(IPacketFactory, PacketLoader, ICipherFactory, boolean)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></dt>
<dd>
<div class="block">Constructs a new EncryptedPacket with the specified <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <code>ICipherFactory</code>
and if the encrypted data should be cached.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#EncryptedPacket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.stdcrypt.encryption.ICipherFactory-com.captainalm.lib.calmnet.packet.IPacket-">EncryptedPacket(IPacketFactory, PacketLoader, ICipherFactory, IPacket)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></dt>
<dd>
<div class="block">Constructs a new EncryptedPacket with the specified <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <code>ICipherFactory</code> and <a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#EncryptedPacket-com.captainalm.lib.calmnet.packet.factory.IPacketFactory-com.captainalm.lib.calmnet.packet.PacketLoader-com.captainalm.lib.stdcrypt.encryption.ICipherFactory-com.captainalm.lib.calmnet.packet.IPacket-boolean-">EncryptedPacket(IPacketFactory, PacketLoader, ICipherFactory, IPacket, boolean)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></dt>
<dd>
<div class="block">Constructs a new EncryptedPacket with the specified <a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a>, <a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>, <code>ICipherFactory</code>,
<a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> and if the encrypted data should be cached.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#equalityVerifyFragments">equalityVerifyFragments</a></span> - Variable in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a></dt>
<dd>
<div class="block">See:
<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#setSentDataWillBeAllVerified-boolean-"><code>FragmentSender.setSentDataWillBeAllVerified(boolean)</code></a> ,
<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setSentDataWillBeAllVerified-boolean-"><code>FragmentReceiver.setSentDataWillBeAllVerified(boolean)</code></a></div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/CandidateClient.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/CandidateClient.html" title="class in com.captainalm.lib.calmnet.marshal">CandidateClient</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a></dt>
<dd>
<div class="block">Gets whether this object equals the passed object.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;</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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-4.html">Prev Letter</a></li>
<li><a href="index-6.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-5.html" target="_top">Frames</a></li>
<li><a href="index-5.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>

View File

@ -0,0 +1,266 @@
<!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:22 BST 2023 -->
<title>F-Index</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="F-Index";
}
}
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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-5.html">Prev Letter</a></li>
<li><a href="index-7.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-6.html" target="_top">Frames</a></li>
<li><a href="index-6.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="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;<a name="I:F">
<!-- -->
</a>
<h2 class="title">F</h2>
<dl>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#flush--">flush()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Flushes the output streams.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#flush--">flush()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Flushes all the output streams on all the clients.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#flush--">flush()</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkOutputStream</a></dt>
<dd>
<div class="block">Flushes this output stream and forces any buffered output bytes
to be written out.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentAllocatePacket</span></a> - Class in <a href="../com/captainalm/lib/calmnet/packet/fragment/package-summary.html">com.captainalm.lib.calmnet.packet.fragment</a></dt>
<dd>
<div class="block">This class provides a packet for fragment allocation requesting.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html#FragmentAllocatePacket-java.lang.Integer-java.util.UUID-">FragmentAllocatePacket(Integer, UUID)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentAllocatePacket</a></dt>
<dd>
<div class="block">Constructs a new FragmentAllocatePacket given the fragment count and allocation UUID.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentAllocationPacket</span></a> - Class in <a href="../com/captainalm/lib/calmnet/packet/fragment/package-summary.html">com.captainalm.lib.calmnet.packet.fragment</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html#FragmentAllocationPacket-java.lang.Integer-java.util.UUID-java.lang.Boolean-">FragmentAllocationPacket(Integer, UUID, Boolean)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentAllocationPacket</a></dt>
<dd>
<div class="block">Constructs a new FragmentAllocationPacket given the packet ID, allocation ID and if it's successful.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">FragmentationOptions</span></a> - Class in <a href="../com/captainalm/lib/calmnet/marshal/package-summary.html">com.captainalm.lib.calmnet.marshal</a></dt>
<dd>
<div class="block">This class provides fragmentation options for using <a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentSender</code></a>s and
<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentReceiver</code></a>s in this package.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#FragmentationOptions--">FragmentationOptions()</a></span> - Constructor for class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#FragmentationOptions-com.captainalm.lib.calmnet.marshal.FragmentationOptions-">FragmentationOptions(FragmentationOptions)</a></span> - Constructor for class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a></dt>
<dd>
<div class="block">Creates a copy of the provided FragmentationOptions.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#fragmentationSplitSize">fragmentationSplitSize</a></span> - Variable in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a></dt>
<dd>
<div class="block">See:
<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#setSplitSize-int-"><code>FragmentSender.setSplitSize(int)</code></a></div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentMessagePacket</span></a> - Class in <a href="../com/captainalm/lib/calmnet/packet/fragment/package-summary.html">com.captainalm.lib.calmnet.packet.fragment</a></dt>
<dd>
<div class="block">This class provides a packet for sending a payload with a packetID and fragmentID.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html#FragmentMessagePacket-java.lang.Integer-java.lang.Integer-byte:A-">FragmentMessagePacket(Integer, Integer, byte[])</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentMessagePacket</a></dt>
<dd>
<div class="block">Constructs a new FragmentMessagePacket given the packet ID, fragment ID and payload.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentMessageResponsePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentMessageResponsePacket</span></a> - Class in <a href="../com/captainalm/lib/calmnet/packet/fragment/package-summary.html">com.captainalm.lib.calmnet.packet.fragment</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentMessageResponsePacket.html#FragmentMessageResponsePacket-java.lang.Integer-java.lang.Integer-byte:A-">FragmentMessageResponsePacket(Integer, Integer, byte[])</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentMessageResponsePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentMessageResponsePacket</a></dt>
<dd>
<div class="block">Constructs a new FragmentMessageResponsePacket given the packet ID, fragment ID and payload.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentPIDAKNPacket</span></a> - Class in <a href="../com/captainalm/lib/calmnet/packet/fragment/package-summary.html">com.captainalm.lib.calmnet.packet.fragment</a></dt>
<dd>
<div class="block">This abstract base class provides the ability for packets to contain an ID and if it is an Acknowledgement.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html#FragmentPIDAKNPacket-java.lang.Integer-java.lang.Boolean-">FragmentPIDAKNPacket(Integer, Boolean)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDAKNPacket</a></dt>
<dd>
<div class="block">Constructs a new FragmentPIDPacket given the packet ID and the acknowledgement value.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentPIDMSGPacket</span></a> - Class in <a href="../com/captainalm/lib/calmnet/packet/fragment/package-summary.html">com.captainalm.lib.calmnet.packet.fragment</a></dt>
<dd>
<div class="block">This abstract base class provides the ability for packets to contain an ID, a Fragment ID and a payload.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html#FragmentPIDMSGPacket-java.lang.Integer-java.lang.Integer-byte:A-">FragmentPIDMSGPacket(Integer, Integer, byte[])</a></span> - Constructor for 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></dt>
<dd>
<div class="block">Constructs a new FragmentPIDMSGPacket given the packet ID, fragment ID and payload.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentPIDPacket</span></a> - Class in <a href="../com/captainalm/lib/calmnet/packet/fragment/package-summary.html">com.captainalm.lib.calmnet.packet.fragment</a></dt>
<dd>
<div class="block">This abstract base class provides the ability for packets to return an ID.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html#FragmentPIDPacket-java.lang.Integer-">FragmentPIDPacket(Integer)</a></span> - Constructor for 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></dt>
<dd>
<div class="block">Constructs a new FragmentPIDPacket given the packet ID.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentReceiver</span></a> - Class in <a href="../com/captainalm/lib/calmnet/packet/fragment/package-summary.html">com.captainalm.lib.calmnet.packet.fragment</a></dt>
<dd>
<div class="block">This class provides the ability to re-construct packets from <code>com.captainalm.lib.calmnet.packet.fragment</code>.</div>
</dd>
<dt><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(PacketLoader, IPacketFactory)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></dt>
<dd>
<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>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentRetrySendPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentRetrySendPacket</span></a> - Class in <a href="../com/captainalm/lib/calmnet/packet/fragment/package-summary.html">com.captainalm.lib.calmnet.packet.fragment</a></dt>
<dd>
<div class="block">This class provides a packet for signalling that the sending end
should start re-sending un acknowledged fragment packets.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentRetrySendPacket.html#FragmentRetrySendPacket-java.lang.Integer-java.lang.Boolean-">FragmentRetrySendPacket(Integer, Boolean)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentRetrySendPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentRetrySendPacket</a></dt>
<dd>
<div class="block">Constructs a new FragmentRetrySendPacket given the packet ID and the acknowledgement value.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentSendCompletePacket</span></a> - Class in <a href="../com/captainalm/lib/calmnet/packet/fragment/package-summary.html">com.captainalm.lib.calmnet.packet.fragment</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendCompletePacket.html#FragmentSendCompletePacket-java.lang.Integer-java.lang.Boolean-">FragmentSendCompletePacket(Integer, Boolean)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendCompletePacket</a></dt>
<dd>
<div class="block">Constructs a new FragmentSendCompletePacket given the packet ID and the acknowledgement value.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentSender</span></a> - Class in <a href="../com/captainalm/lib/calmnet/packet/fragment/package-summary.html">com.captainalm.lib.calmnet.packet.fragment</a></dt>
<dd>
<div class="block">This class provides the ability to create packets for <code>com.captainalm.lib.calmnet.packet.fragment</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#FragmentSender-com.captainalm.lib.calmnet.packet.PacketLoader-">FragmentSender(PacketLoader)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a></dt>
<dd>
<div class="block">Constructs a new FragmentSender with the specified <a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketLoader</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#FragmentSender-com.captainalm.lib.calmnet.packet.PacketLoader-int-">FragmentSender(PacketLoader, int)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a></dt>
<dd>
<div class="block">Constructs a new FragmentSender 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 packet split size in bytes.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendStopPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentSendStopPacket</span></a> - Class in <a href="../com/captainalm/lib/calmnet/packet/fragment/package-summary.html">com.captainalm.lib.calmnet.packet.fragment</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendStopPacket.html#FragmentSendStopPacket-java.lang.Integer-">FragmentSendStopPacket(Integer)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendStopPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendStopPacket</a></dt>
<dd>
<div class="block">Constructs a new FragmentSendStopPacket given the packet ID.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendVerifyCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentSendVerifyCompletePacket</span></a> - Class in <a href="../com/captainalm/lib/calmnet/packet/fragment/package-summary.html">com.captainalm.lib.calmnet.packet.fragment</a></dt>
<dd>
<div class="block">This class provides a packet for stating that all packets have been successfully sent and verified.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendVerifyCompletePacket.html#FragmentSendVerifyCompletePacket-java.lang.Integer-">FragmentSendVerifyCompletePacket(Integer)</a></span> - Constructor for class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendVerifyCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendVerifyCompletePacket</a></dt>
<dd>
<div class="block">Constructs a new FragmentSendVerifyCompletePacket given the packet ID.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;</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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-5.html">Prev Letter</a></li>
<li><a href="index-7.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-6.html" target="_top">Frames</a></li>
<li><a href="index-6.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>

View File

@ -0,0 +1,582 @@
<!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:22 BST 2023 -->
<title>G-Index</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="G-Index";
}
}
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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-6.html">Prev Letter</a></li>
<li><a href="index-8.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-7.html" target="_top">Frames</a></li>
<li><a href="index-7.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="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;<a name="I:G">
<!-- -->
</a>
<h2 class="title">G</h2>
<dl>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getAcceptExceptionBiConsumer--">getAcceptExceptionBiConsumer()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Gets the <code>BiConsumer</code> accept exception consumer.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#getAddress--">getAddress()</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkInputStream</a></dt>
<dd>
<div class="block">Gets the current <code>InetAddress</code> of the stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#getAddress--">getAddress()</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkOutputStream</a></dt>
<dd>
<div class="block">Gets the current <code>InetAddress</code> of the stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html#getAllocationID--">getAllocationID()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentAllocatePacket</a></dt>
<dd>
<div class="block">Gets the allocation ID or null.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html#getAllocationID--">getAllocationID()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentAllocationPacket</a></dt>
<dd>
<div class="block">Gets the allocation ID or null.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html#getByteArrayFromInteger-int-">getByteArrayFromInteger(int)</a></span> - Static method in class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a></dt>
<dd>
<div class="block">Saves an Integer into a byte array.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#getCipherFactory--">getCipherFactory()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></dt>
<dd>
<div class="block">Gets the <code>ICipherFactory</code> being used.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#getCipherFactory--">getCipherFactory()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionUpgradePacket</a></dt>
<dd>
<div class="block">Gets the <code>ICipherFactory</code> being used or null.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#getCipherFactory--">getCipherFactory()</a></span> - Method in class com.captainalm.lib.calmnet.packet.factory.<a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactory</a></dt>
<dd>
<div class="block">Gets the <code>ICipherFactory</code> in use (Could be the same instance).</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html#getCiphers--">getCiphers()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionCipherPacket</a></dt>
<dd>
<div class="block">Gets the cipher names this packet contains.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getClientAcceptanceBiConsumer--">getClientAcceptanceBiConsumer()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Gets the <code>BiConsumer</code> client acceptance consumer.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#getClosedConsumer--">getClosedConsumer()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Gets the <code>Consumer</code> closed consumer.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getClosedConsumer--">getClosedConsumer()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Gets the <code>Consumer</code> closed consumer.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getConnectedClients--">getConnectedClients()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Gets the current set of connected <a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal"><code>NetMarshalClient</code></a>s.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#getDatagramSocket--">getDatagramSocket()</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkInputStream</a></dt>
<dd>
<div class="block">Gets the datagram socket in use or null.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#getDatagramSocket--">getDatagramSocket()</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkOutputStream</a></dt>
<dd>
<div class="block">Gets the datagram socket in use or null.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#getFactory--">getFactory()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core">Base64Packet</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#getFactory--">getFactory()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#getFragmentationOptions--">getFragmentationOptions()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Gets the <a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a> of the client.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getFragmentationOptions--">getFragmentationOptions()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Gets the <a href="../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><code>FragmentationOptions</code></a> of the client.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html#getFragmentCount--">getFragmentCount()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentAllocatePacket</a></dt>
<dd>
<div class="block">Gets the number of fragments or null.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html#getFragmentID--">getFragmentID()</a></span> - Method in 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></dt>
<dd>
<div class="block">Gets the fragment ID or null.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html#getFragmentMessage--">getFragmentMessage()</a></span> - Method in 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></dt>
<dd>
<div class="block">Gets the fragment message byte array or null.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html#getHashProvider--">getHashProvider()</a></span> - Method in class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a></dt>
<dd>
<div class="block">This field provides the <code>DigestProvider</code> to use for the payload of the packets on the trailer.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#getHeldPacket--">getHeldPacket()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core">Base64Packet</a></dt>
<dd>
<div class="block">Gets the held packet or null.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#getHeldPacket--">getHeldPacket()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></dt>
<dd>
<div class="block">Gets the held packet or null.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#getInputStream--">getInputStream()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Get the input stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html#getIntegerFromByteArray-byte:A-">getIntegerFromByteArray(byte[])</a></span> - Static method in class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a></dt>
<dd>
<div class="block">Loads an Integer from a byte array.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#getLastIDFinished--">getLastIDFinished()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></dt>
<dd>
<div class="block">Gets the last finished packet ID.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#getLastIDFinished--">getLastIDFinished()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a></dt>
<dd>
<div class="block">Gets the last finished packet ID.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#getLocalAddress--">getLocalAddress()</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkInputStream</a></dt>
<dd>
<div class="block">Gets the local <code>InetAddress</code> of the stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#getLocalAddress--">getLocalAddress()</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkOutputStream</a></dt>
<dd>
<div class="block">Gets the local <code>InetAddress</code> of the stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#getLocalPort--">getLocalPort()</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkInputStream</a></dt>
<dd>
<div class="block">Gets the local port of the stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#getLocalPort--">getLocalPort()</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkOutputStream</a></dt>
<dd>
<div class="block">Gets the local port of the stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html#getMajor--">getMajor()</a></span> - Method in class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a></dt>
<dd>
<div class="block">Gets the major protocol for the packet.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html#getMinor--">getMinor()</a></span> - Method in class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a></dt>
<dd>
<div class="block">Gets the minor protocol for the packet.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#getNumberOfEmptySendsTillForcedCompleteOrResend--">getNumberOfEmptySendsTillForcedCompleteOrResend()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></dt>
<dd>
<div class="block">Gets the number of <a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#sendPacket--"><code>FragmentReceiver.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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getOpenedConsumer--">getOpenedConsumer()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Gets the <code>Consumer</code> opened consumer.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#getOutputStream--">getOutputStream()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Get the output stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#getPacket-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">getPacket(PacketProtocolInformation)</a></span> - Method in class com.captainalm.lib.calmnet.packet.factory.<a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactory</a></dt>
<dd>
<div class="block">Constructs a <a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> of the protocol specified by the passed <a href="../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketProtocolInformation</code></a> instance.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactoryWithPacket.html#getPacket-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">getPacket(PacketProtocolInformation)</a></span> - Method in class com.captainalm.lib.calmnet.packet.factory.<a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactoryWithPacket.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactoryWithPacket</a></dt>
<dd>
<div class="block">Constructs a <a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> of the protocol specified by the passed <a href="../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketProtocolInformation</code></a> instance.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactoryWithPacket.html#getPacket--">getPacket()</a></span> - Method in class com.captainalm.lib.calmnet.packet.factory.<a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactoryWithPacket.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactoryWithPacket</a></dt>
<dd>
<div class="block">Gets the <a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> in use (Could be the same instance).</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html#getPacket-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-">getPacket(PacketProtocolInformation)</a></span> - Method in interface com.captainalm.lib.calmnet.packet.factory.<a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a></dt>
<dd>
<div class="block">Constructs a <a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a> of the protocol specified by the passed <a href="../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketProtocolInformation</code></a> instance.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#getPacketFactory--">getPacketFactory()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Gets the packet factory in use.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getPacketFactory--">getPacketFactory()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Gets the packet factory in use.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#getPacketFactory--">getPacketFactory()</a></span> - Method in class com.captainalm.lib.calmnet.packet.factory.<a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactory</a></dt>
<dd>
<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 (Could be the same instance).</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#getPacketFactory--">getPacketFactory()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html#getPacketID--">getPacketID()</a></span> - Method in 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></dt>
<dd>
<div class="block">Gets the packet ID or null.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#getPacketLoader--">getPacketLoader()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Gets the packet loader in use.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getPacketLoader--">getPacketLoader()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Gets the packet loader in use.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#getPacketLoader--">getPacketLoader()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core">Base64Packet</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#getPacketLoader--">getPacketLoader()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html#getPacketLoader--">getPacketLoader()</a></span> - Method in class com.captainalm.lib.calmnet.packet.factory.<a href="../com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html" title="class in com.captainalm.lib.calmnet.packet.factory">CALMNETPacketFactory</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#getPacketLoader--">getPacketLoader()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#getPacketLoader--">getPacketLoader()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html#getPacketSize-com.captainalm.lib.calmnet.packet.IPacket-boolean-boolean-">getPacketSize(IPacket, boolean, boolean)</a></span> - Method in class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a></dt>
<dd>
<div class="block">Gets the total size of a written packet in bytes.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#getPacketSize--">getPacketSize()</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkInputStream</a></dt>
<dd>
<div class="block">Gets the current datagram packet size.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#getPort--">getPort()</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkInputStream</a></dt>
<dd>
<div class="block">Gets the current port of the stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#getPort--">getPort()</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkOutputStream</a></dt>
<dd>
<div class="block">Gets the current port of the stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#getProtocol--">getProtocol()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core">Base64Packet</a></dt>
<dd>
<div class="block">Gets the protocol information.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#getProtocol--">getProtocol()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></dt>
<dd>
<div class="block">Gets the protocol information.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html#getProtocol--">getProtocol()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionCipherPacket</a></dt>
<dd>
<div class="block">Gets the protocol information.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#getProtocol--">getProtocol()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionUpgradePacket</a></dt>
<dd>
<div class="block">Gets the protocol information.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html#getProtocol--">getProtocol()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkIdentifierPacket</a></dt>
<dd>
<div class="block">Gets the protocol information.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html#getProtocol--">getProtocol()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkSSLUpgradePacket</a></dt>
<dd>
<div class="block">Gets the protocol information.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html#getProtocol--">getProtocol()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentAllocatePacket</a></dt>
<dd>
<div class="block">Gets the protocol information.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html#getProtocol--">getProtocol()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentAllocationPacket</a></dt>
<dd>
<div class="block">Gets the protocol information.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html#getProtocol--">getProtocol()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentMessagePacket</a></dt>
<dd>
<div class="block">Gets the protocol information.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentMessageResponsePacket.html#getProtocol--">getProtocol()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentMessageResponsePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentMessageResponsePacket</a></dt>
<dd>
<div class="block">Gets the protocol information.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentRetrySendPacket.html#getProtocol--">getProtocol()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentRetrySendPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentRetrySendPacket</a></dt>
<dd>
<div class="block">Gets the protocol information.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendCompletePacket.html#getProtocol--">getProtocol()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendCompletePacket</a></dt>
<dd>
<div class="block">Gets the protocol information.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendStopPacket.html#getProtocol--">getProtocol()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendStopPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendStopPacket</a></dt>
<dd>
<div class="block">Gets the protocol information.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendVerifyCompletePacket.html#getProtocol--">getProtocol()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendVerifyCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendVerifyCompletePacket</a></dt>
<dd>
<div class="block">Gets the protocol information.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/IPacket.html#getProtocol--">getProtocol()</a></span> - Method in 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></dt>
<dd>
<div class="block">Gets the protocol information.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html#getProtocolInformation-java.io.InputStream-">getProtocolInformation(InputStream)</a></span> - Static method in class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a></dt>
<dd>
<div class="block">Gets the <a href="../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketProtocolInformation</code></a> of the packet.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#getReceiveBiConsumer--">getReceiveBiConsumer()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Gets the <code>BiConsumer</code> receiver consumer.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getReceiveBiConsumer--">getReceiveBiConsumer()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Gets the <code>BiConsumer</code> receiver consumer.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#getReceiveExceptionBiConsumer--">getReceiveExceptionBiConsumer()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Gets the <code>BiConsumer</code> receive exception consumer.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getReceiveExceptionBiConsumer--">getReceiveExceptionBiConsumer()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Gets the <code>BiConsumer</code> receive exception consumer.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#getRootInputStream--">getRootInputStream()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Get the root input stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#getRootOutputStream--">getRootOutputStream()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Get the root output stream.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#getSize--">getSize()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core">Base64Packet</a></dt>
<dd>
<div class="block">Gets the size of the output data.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#getSize--">getSize()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></dt>
<dd>
<div class="block">Gets the size of the output data.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html#getSize--">getSize()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionCipherPacket</a></dt>
<dd>
<div class="block">Gets the size of the output data.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/IStreamedPacket.html#getSize--">getSize()</a></span> - Method in interface com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</a></dt>
<dd>
<div class="block">Gets the size of the output data.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html#getSocket--">getSocket()</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkInputStream</a></dt>
<dd>
<div class="block">Gets the socket in use or null.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html#getSocket--">getSocket()</a></span> - Method in class com.captainalm.lib.calmnet.stream.<a href="../com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream">NetworkOutputStream</a></dt>
<dd>
<div class="block">Gets the socket in use or null.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#getSocketSetupBiConsumer--">getSocketSetupBiConsumer()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Gets the <code>BiConsumer</code> socket setup consumer.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#getSplitSize--">getSplitSize()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a></dt>
<dd>
<div class="block">Gets the current packet split size in bytes.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#getSSLClientSocket-javax.net.ssl.SSLContext-java.lang.String-int-">getSSLClientSocket(SSLContext, String, int)</a></span> - Static method in class com.captainalm.lib.calmnet.ssl.<a href="../com/captainalm/lib/calmnet/ssl/SSLUtilities.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilities</a></dt>
<dd>
<div class="block">Creates a new <code>SSLSocket</code> using the specified <code>SSLContext</code>, host and port.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#getSSLContext-java.lang.String-java.security.KeyStore-char:A-">getSSLContext(String, KeyStore, char[])</a></span> - Static method in class com.captainalm.lib.calmnet.ssl.<a href="../com/captainalm/lib/calmnet/ssl/SSLUtilities.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilities</a></dt>
<dd>
<div class="block">Gets the SSL context merged with the JRE Trust Store using a unified <code>KeyStore</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#getSSLContext-java.lang.String-java.security.KeyStore-char:A-java.security.KeyStore-">getSSLContext(String, KeyStore, char[], KeyStore)</a></span> - Static method in class com.captainalm.lib.calmnet.ssl.<a href="../com/captainalm/lib/calmnet/ssl/SSLUtilities.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilities</a></dt>
<dd>
<div class="block">Gets the SSL context merged with the JRE Trust Store using separate private and trust <code>KeyStore</code>s.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#getSSLContextNoJRETrust-java.lang.String-java.security.KeyStore-char:A-">getSSLContextNoJRETrust(String, KeyStore, char[])</a></span> - Static method in class com.captainalm.lib.calmnet.ssl.<a href="../com/captainalm/lib/calmnet/ssl/SSLUtilities.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilities</a></dt>
<dd>
<div class="block">Gets the SSL context without the JRE Trust Store using a unified <code>KeyStore</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#getSSLContextNoJRETrust-java.lang.String-java.security.KeyStore-char:A-java.security.KeyStore-">getSSLContextNoJRETrust(String, KeyStore, char[], KeyStore)</a></span> - Static method in class com.captainalm.lib.calmnet.ssl.<a href="../com/captainalm/lib/calmnet/ssl/SSLUtilities.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilities</a></dt>
<dd>
<div class="block">Gets the SSL context without the JRE Trust Store using separate private and trust <code>KeyStore</code>s.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#getSSLServerSocket-javax.net.ssl.SSLContext-int-int-java.net.InetAddress-">getSSLServerSocket(SSLContext, int, int, InetAddress)</a></span> - Static method in class com.captainalm.lib.calmnet.ssl.<a href="../com/captainalm/lib/calmnet/ssl/SSLUtilities.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilities</a></dt>
<dd>
<div class="block">Gets the SSL Server socket for the specified <code>SSLContext</code>, port, backlog and <code>InetAddress</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#getTheProtocol--">getTheProtocol()</a></span> - Static method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core">Base64Packet</a></dt>
<dd>
<div class="block">Gets the protocol information statically.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#getTheProtocol--">getTheProtocol()</a></span> - Static method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></dt>
<dd>
<div class="block">Gets the protocol information statically.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html#getTheProtocol--">getTheProtocol()</a></span> - Static method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionCipherPacket</a></dt>
<dd>
<div class="block">Gets the protocol information statically.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#getTheProtocol--">getTheProtocol()</a></span> - Static method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionUpgradePacket</a></dt>
<dd>
<div class="block">Gets the protocol information statically.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html#getTheProtocol--">getTheProtocol()</a></span> - Static method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkIdentifierPacket</a></dt>
<dd>
<div class="block">Gets the protocol information statically.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html#getTheProtocol--">getTheProtocol()</a></span> - Static method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkSSLUpgradePacket</a></dt>
<dd>
<div class="block">Gets the protocol information statically.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html#getTheProtocol--">getTheProtocol()</a></span> - Static method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentAllocatePacket</a></dt>
<dd>
<div class="block">Gets the protocol information statically.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html#getTheProtocol--">getTheProtocol()</a></span> - Static method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentAllocationPacket</a></dt>
<dd>
<div class="block">Gets the protocol information statically.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html#getTheProtocol--">getTheProtocol()</a></span> - Static method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentMessagePacket</a></dt>
<dd>
<div class="block">Gets the protocol information statically.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentMessageResponsePacket.html#getTheProtocol--">getTheProtocol()</a></span> - Static method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentMessageResponsePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentMessageResponsePacket</a></dt>
<dd>
<div class="block">Gets the protocol information statically.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentRetrySendPacket.html#getTheProtocol--">getTheProtocol()</a></span> - Static method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentRetrySendPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentRetrySendPacket</a></dt>
<dd>
<div class="block">Gets the protocol information statically.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendCompletePacket.html#getTheProtocol--">getTheProtocol()</a></span> - Static method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendCompletePacket</a></dt>
<dd>
<div class="block">Gets the protocol information statically.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendStopPacket.html#getTheProtocol--">getTheProtocol()</a></span> - Static method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendStopPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendStopPacket</a></dt>
<dd>
<div class="block">Gets the protocol information statically.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendVerifyCompletePacket.html#getTheProtocol--">getTheProtocol()</a></span> - Static method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentSendVerifyCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSendVerifyCompletePacket</a></dt>
<dd>
<div class="block">Gets the protocol information statically.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#getTrailingPassword--">getTrailingPassword()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></dt>
<dd>
<div class="block">Gets the trailing password (Or null if no trailing password).</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClientWrapped.html#getWrapperInputStream--">getWrapperInputStream()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClientWrapped.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClientWrapped</a></dt>
<dd>
<div class="block">Gets the <code>Function</code> input stream wrapper function.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServerWrapped.html#getWrapperInputStream--">getWrapperInputStream()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServerWrapped.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServerWrapped</a></dt>
<dd>
<div class="block">Gets the <code>Function</code> input stream wrapper function.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClientWrapped.html#getWrapperOutputStream--">getWrapperOutputStream()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClientWrapped.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClientWrapped</a></dt>
<dd>
<div class="block">Gets the <code>Function</code> output stream wrapper function.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServerWrapped.html#getWrapperOutputStream--">getWrapperOutputStream()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServerWrapped.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServerWrapped</a></dt>
<dd>
<div class="block">Gets the <code>Function</code> output stream wrapper function.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;</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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-6.html">Prev Letter</a></li>
<li><a href="index-8.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-7.html" target="_top">Frames</a></li>
<li><a href="index-7.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>

View File

@ -0,0 +1,131 @@
<!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:22 BST 2023 -->
<title>H-Index</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="H-Index";
}
}
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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-7.html">Prev Letter</a></li>
<li><a href="index-9.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-8.html" target="_top">Frames</a></li>
<li><a href="index-8.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="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;<a name="I:H">
<!-- -->
</a>
<h2 class="title">H</h2>
<dl>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/CandidateClient.html#hashCode--">hashCode()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/CandidateClient.html" title="class in com.captainalm.lib.calmnet.marshal">CandidateClient</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html#hashCode--">hashCode()</a></span> - Method in class com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a></dt>
<dd>
<div class="block">Gets the hash code of the object.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;</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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-7.html">Prev Letter</a></li>
<li><a href="index-9.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-8.html" target="_top">Frames</a></li>
<li><a href="index-8.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>

View File

@ -0,0 +1,255 @@
<!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:22 BST 2023 -->
<title>I-Index</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="I-Index";
}
}
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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-8.html">Prev Letter</a></li>
<li><a href="index-10.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-9.html" target="_top">Frames</a></li>
<li><a href="index-9.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="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;<a name="I:I">
<!-- -->
</a>
<h2 class="title">I</h2>
<dl>
<dt><a href="../com/captainalm/lib/calmnet/packet/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">IAcknowledgement</span></a> - Interface in <a href="../com/captainalm/lib/calmnet/packet/package-summary.html">com.captainalm.lib.calmnet.packet</a></dt>
<dd>
<div class="block">This interface allows obtaining if the class instance is an Acknowledgement.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/IInternalCache.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">IInternalCache</span></a> - Interface in <a href="../com/captainalm/lib/calmnet/packet/package-summary.html">com.captainalm.lib.calmnet.packet</a></dt>
<dd>
<div class="block">This interface allows getting and setting if the
internal cache should be used within a class instance.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">IPacket</span></a> - Interface in <a href="../com/captainalm/lib/calmnet/packet/package-summary.html">com.captainalm.lib.calmnet.packet</a></dt>
<dd>
<div class="block">This interface provides the packet methods.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><span class="typeNameLink">IPacketFactory</span></a> - Interface in <a href="../com/captainalm/lib/calmnet/packet/factory/package-summary.html">com.captainalm.lib.calmnet.packet.factory</a></dt>
<dd>
<div class="block">This interface provides the ability to construct <a href="../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>s given their <a href="../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><code>PacketProtocolInformation</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html#isAcknowledgement--">isAcknowledgement()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionCipherPacket</a></dt>
<dd>
<div class="block">Gets if the class instance is an Acknowledgement.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#isAcknowledgement--">isAcknowledgement()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionUpgradePacket</a></dt>
<dd>
<div class="block">Gets if the class instance is an Acknowledgement.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html#isAcknowledgement--">isAcknowledgement()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkSSLUpgradePacket</a></dt>
<dd>
<div class="block">Gets if the class instance is an Acknowledgement.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html#isAcknowledgement--">isAcknowledgement()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDAKNPacket</a></dt>
<dd>
<div class="block">Gets if the class instance is an Acknowledgement.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/IAcknowledgement.html#isAcknowledgement--">isAcknowledgement()</a></span> - Method in interface com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a></dt>
<dd>
<div class="block">Gets if the class instance is an Acknowledgement.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#isBase64ed--">isBase64ed()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionUpgradePacket</a></dt>
<dd>
<div class="block">Gets if base 64 is used.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#isCacheUsed--">isCacheUsed()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core">Base64Packet</a></dt>
<dd>
<div class="block">Gets if the encrypted data is cached.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#isCacheUsed--">isCacheUsed()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></dt>
<dd>
<div class="block">Gets if the encrypted data is cached.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html#isCacheUsed--">isCacheUsed()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionCipherPacket</a></dt>
<dd>
<div class="block">Gets if the cipher information is cached.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/IInternalCache.html#isCacheUsed--">isCacheUsed()</a></span> - Method in interface com.captainalm.lib.calmnet.packet.<a href="../com/captainalm/lib/calmnet/packet/IInternalCache.html" title="interface in com.captainalm.lib.calmnet.packet">IInternalCache</a></dt>
<dd>
<div class="block">Gets if the internal cache is used.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#isRunning--">isRunning()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Gets if the marshal is running.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html#isRunning--">isRunning()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a></dt>
<dd>
<div class="block">Gets if the marshal is running.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html#isSSLUpgraded--">isSSLUpgraded()</a></span> - Method in class com.captainalm.lib.calmnet.marshal.<a href="../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a></dt>
<dd>
<div class="block">Gets if the marshal is ssl upgraded.</div>
</dd>
<dt><a href="../com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">IStreamedPacket</span></a> - Interface in <a href="../com/captainalm/lib/calmnet/packet/package-summary.html">com.captainalm.lib.calmnet.packet</a></dt>
<dd>
<div class="block">This interface provides the streaming packet methods.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#isUpgrade--">isUpgrade()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionUpgradePacket</a></dt>
<dd>
<div class="block">Gets if the packet is treated as a stream upgrade or
a change in packet use for <a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><code>EncryptedPacket</code></a> and <a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core"><code>Base64Packet</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html#isValid--">isValid()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core">Base64Packet</a></dt>
<dd>
<div class="block">Gets if the packet is valid.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html#isValid--">isValid()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">EncryptedPacket</a></dt>
<dd>
<div class="block">Gets if the packet is valid.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html#isValid--">isValid()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionCipherPacket</a></dt>
<dd>
<div class="block">Gets if the packet is valid.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#isValid--">isValid()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkEncryptionUpgradePacket</a></dt>
<dd>
<div class="block">Gets if the packet is valid.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html#isValid--">isValid()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkIdentifierPacket</a></dt>
<dd>
<div class="block">Gets if the packet is valid.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html#isValid--">isValid()</a></span> - Method in class com.captainalm.lib.calmnet.packet.core.<a href="../com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core">NetworkSSLUpgradePacket</a></dt>
<dd>
<div class="block">Gets if the packet is valid.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html#isValid--">isValid()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentAllocatePacket</a></dt>
<dd>
<div class="block">Gets if the packet is valid.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html#isValid--">isValid()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentAllocationPacket</a></dt>
<dd>
<div class="block">Gets if the packet is valid.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html#isValid--">isValid()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentMessagePacket</a></dt>
<dd>
<div class="block">Gets if the packet is valid.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html#isValid--">isValid()</a></span> - Method in class com.captainalm.lib.calmnet.packet.fragment.<a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDAKNPacket</a></dt>
<dd>
<div class="block">Gets if the packet is valid.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html#isValid--">isValid()</a></span> - Method in 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></dt>
<dd>
<div class="block">Gets if the packet is valid.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html#isValid--">isValid()</a></span> - Method in 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></dt>
<dd>
<div class="block">Gets if the packet is valid.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/captainalm/lib/calmnet/packet/IPacket.html#isValid--">isValid()</a></span> - Method in 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></dt>
<dd>
<div class="block">Gets if the packet is valid.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">L</a>&nbsp;<a href="index-11.html">M</a>&nbsp;<a href="index-12.html">N</a>&nbsp;<a href="index-13.html">O</a>&nbsp;<a href="index-14.html">P</a>&nbsp;<a href="index-15.html">R</a>&nbsp;<a href="index-16.html">S</a>&nbsp;<a href="index-17.html">U</a>&nbsp;<a href="index-18.html">V</a>&nbsp;<a href="index-19.html">W</a>&nbsp;</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>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="index-8.html">Prev Letter</a></li>
<li><a href="index-10.html">Next Letter</a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?index-files/index-9.html" target="_top">Frames</a></li>
<li><a href="index-9.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>

75
JavaDoc/index.html Normal file
View File

@ -0,0 +1,75 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_262) on Tue May 23 15:22:22 BST 2023 -->
<title>Generated Documentation (Untitled)</title>
<script type="text/javascript">
tmpTargetPage = "" + window.location.search;
if (tmpTargetPage != "" && tmpTargetPage != "undefined")
tmpTargetPage = tmpTargetPage.substring(1);
if (tmpTargetPage.indexOf(":") != -1 || (tmpTargetPage != "" && !validURL(tmpTargetPage)))
tmpTargetPage = "undefined";
targetPage = tmpTargetPage;
function validURL(url) {
try {
url = decodeURIComponent(url);
}
catch (error) {
return false;
}
var pos = url.indexOf(".html");
if (pos == -1 || pos != url.length - 5)
return false;
var allowNumber = false;
var allowSep = false;
var seenDot = false;
for (var i = 0; i < url.length - 5; i++) {
var ch = url.charAt(i);
if ('a' <= ch && ch <= 'z' ||
'A' <= ch && ch <= 'Z' ||
ch == '$' ||
ch == '_' ||
ch.charCodeAt(0) > 127) {
allowNumber = true;
allowSep = true;
} else if ('0' <= ch && ch <= '9'
|| ch == '-') {
if (!allowNumber)
return false;
} else if (ch == '/' || ch == '.') {
if (!allowSep)
return false;
allowNumber = false;
allowSep = false;
if (ch == '.')
seenDot = true;
if (ch == '/' && seenDot)
return false;
} else {
return false;
}
}
return true;
}
function loadFrames() {
if (targetPage != "" && targetPage != "undefined")
top.classFrame.location = top.targetPage;
}
</script>
</head>
<frameset cols="20%,80%" title="Documentation frame" onload="top.loadFrames()">
<frameset rows="30%,70%" title="Left frames" onload="top.loadFrames()">
<frame src="overview-frame.html" name="packageListFrame" title="All Packages">
<frame src="allclasses-frame.html" name="packageFrame" title="All classes and interfaces (except non-static nested types)">
</frameset>
<frame src="overview-summary.html" name="classFrame" title="Package, class and interface descriptions" scrolling="yes">
<noframes>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<h2>Frame Alert</h2>
<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p>
</noframes>
</frameset>
</html>

View File

@ -0,0 +1,27 @@
<!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>Overview List</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>
<div class="indexHeader"><span><a href="allclasses-frame.html" target="packageFrame">All&nbsp;Classes</a></span></div>
<div class="indexContainer">
<h2 title="Packages">Packages</h2>
<ul title="Packages">
<li><a href="com/captainalm/lib/calmnet/marshal/package-frame.html" target="packageFrame">com.captainalm.lib.calmnet.marshal</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/package-frame.html" target="packageFrame">com.captainalm.lib.calmnet.packet</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/core/package-frame.html" target="packageFrame">com.captainalm.lib.calmnet.packet.core</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/factory/package-frame.html" target="packageFrame">com.captainalm.lib.calmnet.packet.factory</a></li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/package-frame.html" target="packageFrame">com.captainalm.lib.calmnet.packet.fragment</a></li>
<li><a href="com/captainalm/lib/calmnet/ssl/package-frame.html" target="packageFrame">com.captainalm.lib.calmnet.ssl</a></li>
<li><a href="com/captainalm/lib/calmnet/stream/package-frame.html" target="packageFrame">com.captainalm.lib.calmnet.stream</a></li>
</ul>
</div>
<p>&nbsp;</p>
</body>
</html>

View File

@ -0,0 +1,173 @@
<!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:22 BST 2023 -->
<title>Overview</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="Overview";
}
}
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 class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li><a href="overview-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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
<li><a href="overview-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="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Packages table, listing packages, and an explanation">
<caption><span>Packages</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="com/captainalm/lib/calmnet/marshal/package-summary.html">com.captainalm.lib.calmnet.marshal</a></td>
<td class="colLast">
<div class="block">This package contains the network marshals for managed sending of <a href="com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><code>IPacket</code></a>s on sockets.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/captainalm/lib/calmnet/packet/package-summary.html">com.captainalm.lib.calmnet.packet</a></td>
<td class="colLast">
<div class="block">This package contains the network packets and handling code.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/captainalm/lib/calmnet/packet/core/package-summary.html">com.captainalm.lib.calmnet.packet.core</a></td>
<td class="colLast">
<div class="block">This package contains the core network packets.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/captainalm/lib/calmnet/packet/factory/package-summary.html">com.captainalm.lib.calmnet.packet.factory</a></td>
<td class="colLast">
<div class="block">This package contains the <a href="com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><code>IPacketFactory</code></a> interface and standard classes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/captainalm/lib/calmnet/packet/fragment/package-summary.html">com.captainalm.lib.calmnet.packet.fragment</a></td>
<td class="colLast">
<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>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/captainalm/lib/calmnet/ssl/package-summary.html">com.captainalm.lib.calmnet.ssl</a></td>
<td class="colLast">
<div class="block">This package provides SSL utilities for wrapping
<code>Socket</code>s and creating <code>SSLContext</code>s.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/captainalm/lib/calmnet/stream/package-summary.html">com.captainalm.lib.calmnet.stream</a></td>
<td class="colLast">
<div class="block">This package provides streams for network packet streaming.</div>
</td>
</tr>
</tbody>
</table>
</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 class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li><a href="overview-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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
<li><a href="overview-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>

224
JavaDoc/overview-tree.html Normal file
View File

@ -0,0 +1,224 @@
<!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:22 BST 2023 -->
<title>Class Hierarchy</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="Class Hierarchy";
}
}
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>Package</li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-tree.html" target="_top">Frames</a></li>
<li><a href="overview-tree.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 class="title">Hierarchy For All Packages</h1>
<span class="packageHierarchyLabel">Package Hierarchies:</span>
<ul class="horizontal">
<li><a href="com/captainalm/lib/calmnet/marshal/package-tree.html">com.captainalm.lib.calmnet.marshal</a>, </li>
<li><a href="com/captainalm/lib/calmnet/packet/package-tree.html">com.captainalm.lib.calmnet.packet</a>, </li>
<li><a href="com/captainalm/lib/calmnet/packet/core/package-tree.html">com.captainalm.lib.calmnet.packet.core</a>, </li>
<li><a href="com/captainalm/lib/calmnet/packet/factory/package-tree.html">com.captainalm.lib.calmnet.packet.factory</a>, </li>
<li><a href="com/captainalm/lib/calmnet/packet/fragment/package-tree.html">com.captainalm.lib.calmnet.packet.fragment</a>, </li>
<li><a href="com/captainalm/lib/calmnet/ssl/package-tree.html">com.captainalm.lib.calmnet.ssl</a>, </li>
<li><a href="com/captainalm/lib/calmnet/stream/package-tree.html">com.captainalm.lib.calmnet.stream</a></li>
</ul>
</div>
<div class="contentContainer">
<h2 title="Class Hierarchy">Class Hierarchy</h2>
<ul>
<li type="circle">java.lang.Object
<ul>
<li type="circle">com.captainalm.lib.calmnet.packet.core.<a href="com/captainalm/lib/calmnet/packet/core/Base64Packet.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">Base64Packet</span></a> (implements com.captainalm.lib.calmnet.packet.<a href="com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</a>)</li>
<li type="circle">com.captainalm.lib.calmnet.packet.factory.<a href="com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactory.html" title="class in com.captainalm.lib.calmnet.packet.factory"><span class="typeNameLink">CALMNETPacketFactory</span></a> (implements com.captainalm.lib.calmnet.packet.factory.<a href="com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a>)
<ul>
<li type="circle">com.captainalm.lib.calmnet.packet.factory.<a href="com/captainalm/lib/calmnet/packet/factory/CALMNETPacketFactoryWithPacket.html" title="class in com.captainalm.lib.calmnet.packet.factory"><span class="typeNameLink">CALMNETPacketFactoryWithPacket</span></a></li>
</ul>
</li>
<li type="circle">com.captainalm.lib.calmnet.marshal.<a href="com/captainalm/lib/calmnet/marshal/CandidateClient.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">CandidateClient</span></a></li>
<li type="circle">com.captainalm.lib.calmnet.packet.core.<a href="com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">EncryptedPacket</span></a> (implements com.captainalm.lib.calmnet.packet.<a href="com/captainalm/lib/calmnet/packet/IInternalCache.html" title="interface in com.captainalm.lib.calmnet.packet">IInternalCache</a>, com.captainalm.lib.calmnet.packet.<a href="com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</a>)</li>
<li type="circle">com.captainalm.lib.calmnet.packet.fragment.<a href="com/captainalm/lib/calmnet/packet/fragment/FragmentAllocatePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentAllocatePacket</span></a> (implements com.captainalm.lib.calmnet.packet.<a href="com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>)</li>
<li type="circle">com.captainalm.lib.calmnet.marshal.<a href="com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">FragmentationOptions</span></a></li>
<li type="circle">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"><span class="typeNameLink">FragmentPIDPacket</span></a> (implements com.captainalm.lib.calmnet.packet.<a href="com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>)
<ul>
<li type="circle">com.captainalm.lib.calmnet.packet.fragment.<a href="com/captainalm/lib/calmnet/packet/fragment/FragmentAllocationPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentAllocationPacket</span></a></li>
<li type="circle">com.captainalm.lib.calmnet.packet.fragment.<a href="com/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentPIDAKNPacket</span></a> (implements com.captainalm.lib.calmnet.packet.<a href="com/captainalm/lib/calmnet/packet/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a>)
<ul>
<li type="circle">com.captainalm.lib.calmnet.packet.fragment.<a href="com/captainalm/lib/calmnet/packet/fragment/FragmentRetrySendPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentRetrySendPacket</span></a></li>
<li type="circle">com.captainalm.lib.calmnet.packet.fragment.<a href="com/captainalm/lib/calmnet/packet/fragment/FragmentSendCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentSendCompletePacket</span></a></li>
</ul>
</li>
<li type="circle">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"><span class="typeNameLink">FragmentPIDMSGPacket</span></a>
<ul>
<li type="circle">com.captainalm.lib.calmnet.packet.fragment.<a href="com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentMessagePacket</span></a></li>
<li type="circle">com.captainalm.lib.calmnet.packet.fragment.<a href="com/captainalm/lib/calmnet/packet/fragment/FragmentMessageResponsePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentMessageResponsePacket</span></a></li>
</ul>
</li>
<li type="circle">com.captainalm.lib.calmnet.packet.fragment.<a href="com/captainalm/lib/calmnet/packet/fragment/FragmentSendStopPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentSendStopPacket</span></a></li>
<li type="circle">com.captainalm.lib.calmnet.packet.fragment.<a href="com/captainalm/lib/calmnet/packet/fragment/FragmentSendVerifyCompletePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentSendVerifyCompletePacket</span></a></li>
</ul>
</li>
<li type="circle">com.captainalm.lib.calmnet.packet.fragment.<a href="com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentReceiver</span></a></li>
<li type="circle">com.captainalm.lib.calmnet.packet.fragment.<a href="com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">FragmentSender</span></a></li>
<li type="circle">java.io.InputStream (implements java.io.Closeable)
<ul>
<li type="circle">java.io.FilterInputStream
<ul>
<li type="circle">com.captainalm.lib.calmnet.stream.<a href="com/captainalm/lib/calmnet/stream/LengthClampedInputStream.html" title="class in com.captainalm.lib.calmnet.stream"><span class="typeNameLink">LengthClampedInputStream</span></a></li>
</ul>
</li>
<li type="circle">com.captainalm.lib.calmnet.stream.<a href="com/captainalm/lib/calmnet/stream/NetworkInputStream.html" title="class in com.captainalm.lib.calmnet.stream"><span class="typeNameLink">NetworkInputStream</span></a></li>
</ul>
</li>
<li type="circle">com.captainalm.lib.calmnet.marshal.<a href="com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">NetMarshalClient</span></a> (implements java.io.Closeable)
<ul>
<li type="circle">com.captainalm.lib.calmnet.marshal.<a href="com/captainalm/lib/calmnet/marshal/NetMarshalClientWrapped.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">NetMarshalClientWrapped</span></a></li>
</ul>
</li>
<li type="circle">com.captainalm.lib.calmnet.marshal.<a href="com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">NetMarshalServer</span></a> (implements java.io.Closeable)
<ul>
<li type="circle">com.captainalm.lib.calmnet.marshal.<a href="com/captainalm/lib/calmnet/marshal/NetMarshalServerWrapped.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">NetMarshalServerWrapped</span></a></li>
</ul>
</li>
<li type="circle">com.captainalm.lib.calmnet.packet.core.<a href="com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">NetworkEncryptionCipherPacket</span></a> (implements com.captainalm.lib.calmnet.packet.<a href="com/captainalm/lib/calmnet/packet/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a>, com.captainalm.lib.calmnet.packet.<a href="com/captainalm/lib/calmnet/packet/IInternalCache.html" title="interface in com.captainalm.lib.calmnet.packet">IInternalCache</a>, com.captainalm.lib.calmnet.packet.<a href="com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IStreamedPacket</a>)</li>
<li type="circle">com.captainalm.lib.calmnet.packet.core.<a href="com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">NetworkEncryptionUpgradePacket</span></a> (implements com.captainalm.lib.calmnet.packet.<a href="com/captainalm/lib/calmnet/packet/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a>, com.captainalm.lib.calmnet.packet.<a href="com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>)</li>
<li type="circle">com.captainalm.lib.calmnet.packet.core.<a href="com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">NetworkIdentifierPacket</span></a> (implements com.captainalm.lib.calmnet.packet.<a href="com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>)</li>
<li type="circle">com.captainalm.lib.calmnet.packet.core.<a href="com/captainalm/lib/calmnet/packet/core/NetworkSSLUpgradePacket.html" title="class in com.captainalm.lib.calmnet.packet.core"><span class="typeNameLink">NetworkSSLUpgradePacket</span></a> (implements com.captainalm.lib.calmnet.packet.<a href="com/captainalm/lib/calmnet/packet/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a>, com.captainalm.lib.calmnet.packet.<a href="com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>)</li>
<li type="circle">java.io.OutputStream (implements java.io.Closeable, java.io.Flushable)
<ul>
<li type="circle">com.captainalm.lib.calmnet.stream.<a href="com/captainalm/lib/calmnet/stream/NetworkOutputStream.html" title="class in com.captainalm.lib.calmnet.stream"><span class="typeNameLink">NetworkOutputStream</span></a></li>
</ul>
</li>
<li type="circle">com.captainalm.lib.calmnet.packet.<a href="com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">PacketLoader</span></a></li>
<li type="circle">com.captainalm.lib.calmnet.packet.<a href="com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">PacketProtocolInformation</span></a></li>
<li type="circle">com.captainalm.lib.calmnet.ssl.<a href="com/captainalm/lib/calmnet/ssl/SSLUtilities.html" title="class in com.captainalm.lib.calmnet.ssl"><span class="typeNameLink">SSLUtilities</span></a></li>
<li type="circle">java.lang.Throwable (implements java.io.Serializable)
<ul>
<li type="circle">java.lang.Exception
<ul>
<li type="circle">com.captainalm.lib.calmnet.packet.<a href="com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">PacketException</span></a></li>
<li type="circle">com.captainalm.lib.calmnet.ssl.<a href="com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl"><span class="typeNameLink">SSLUtilityException</span></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h2 title="Interface Hierarchy">Interface Hierarchy</h2>
<ul>
<li type="circle">com.captainalm.lib.calmnet.packet.<a href="com/captainalm/lib/calmnet/packet/IAcknowledgement.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">IAcknowledgement</span></a></li>
<li type="circle">com.captainalm.lib.calmnet.packet.<a href="com/captainalm/lib/calmnet/packet/IInternalCache.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">IInternalCache</span></a></li>
<li type="circle">com.captainalm.lib.calmnet.packet.<a href="com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">IPacket</span></a>
<ul>
<li type="circle">com.captainalm.lib.calmnet.packet.<a href="com/captainalm/lib/calmnet/packet/IStreamedPacket.html" title="interface in com.captainalm.lib.calmnet.packet"><span class="typeNameLink">IStreamedPacket</span></a></li>
</ul>
</li>
<li type="circle">com.captainalm.lib.calmnet.packet.factory.<a href="com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory"><span class="typeNameLink">IPacketFactory</span></a></li>
</ul>
</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>Package</li>
<li>Class</li>
<li class="navBarCell1Rev">Tree</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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-tree.html" target="_top">Frames</a></li>
<li><a href="overview-tree.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>

7
JavaDoc/package-list Normal file
View File

@ -0,0 +1,7 @@
com.captainalm.lib.calmnet.marshal
com.captainalm.lib.calmnet.packet
com.captainalm.lib.calmnet.packet.core
com.captainalm.lib.calmnet.packet.factory
com.captainalm.lib.calmnet.packet.fragment
com.captainalm.lib.calmnet.ssl
com.captainalm.lib.calmnet.stream

30
JavaDoc/script.js Normal file
View File

@ -0,0 +1,30 @@
function show(type)
{
count = 0;
for (var key in methods) {
var row = document.getElementById(key);
if ((methods[key] & type) != 0) {
row.style.display = '';
row.className = (count++ % 2) ? rowColor : altColor;
}
else
row.style.display = 'none';
}
updateTabs(type);
}
function updateTabs(type)
{
for (var value in tabs) {
var sNode = document.getElementById(tabs[value][0]);
var spanNode = sNode.firstChild;
if (value == type) {
sNode.className = activeTableTab;
spanNode.innerHTML = tabs[value][1];
}
else {
sNode.className = tableTab;
spanNode.innerHTML = "<a href=\"javascript:show("+ value + ");\">" + tabs[value][1] + "</a>";
}
}
}

View File

@ -0,0 +1,145 @@
<!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:22 BST 2023 -->
<title>Serialized Form</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="Serialized Form";
}
}
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>Package</li>
<li>Class</li>
<li><a href="overview-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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?serialized-form.html" target="_top">Frames</a></li>
<li><a href="serialized-form.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="Serialized Form" class="title">Serialized Form</h1>
</div>
<div class="serializedFormContainer">
<ul class="blockList">
<li class="blockList">
<h2 title="Package">Package&nbsp;com.captainalm.lib.calmnet.packet</h2>
<ul class="blockList">
<li class="blockList"><a name="com.captainalm.lib.calmnet.packet.PacketException">
<!-- -->
</a>
<h3>Class <a href="com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">com.captainalm.lib.calmnet.packet.PacketException</a> extends java.lang.Exception implements Serializable</h3>
</li>
</ul>
</li>
<li class="blockList">
<h2 title="Package">Package&nbsp;com.captainalm.lib.calmnet.ssl</h2>
<ul class="blockList">
<li class="blockList"><a name="com.captainalm.lib.calmnet.ssl.SSLUtilityException">
<!-- -->
</a>
<h3>Class <a href="com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">com.captainalm.lib.calmnet.ssl.SSLUtilityException</a> extends java.lang.Exception implements Serializable</h3>
</li>
</ul>
</li>
</ul>
</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>Package</li>
<li>Class</li>
<li><a href="overview-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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?serialized-form.html" target="_top">Frames</a></li>
<li><a href="serialized-form.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>

574
JavaDoc/stylesheet.css Normal file
View File

@ -0,0 +1,574 @@
/* Javadoc style sheet */
/*
Overall document style
*/
@import url('resources/fonts/dejavu.css');
body {
background-color:#ffffff;
color:#353833;
font-family:'DejaVu Sans', Arial, Helvetica, sans-serif;
font-size:14px;
margin:0;
}
a:link, a:visited {
text-decoration:none;
color:#4A6782;
}
a:hover, a:focus {
text-decoration:none;
color:#bb7a2a;
}
a:active {
text-decoration:none;
color:#4A6782;
}
a[name] {
color:#353833;
}
a[name]:hover {
text-decoration:none;
color:#353833;
}
pre {
font-family:'DejaVu Sans Mono', monospace;
font-size:14px;
}
h1 {
font-size:20px;
}
h2 {
font-size:18px;
}
h3 {
font-size:16px;
font-style:italic;
}
h4 {
font-size:13px;
}
h5 {
font-size:12px;
}
h6 {
font-size:11px;
}
ul {
list-style-type:disc;
}
code, tt {
font-family:'DejaVu Sans Mono', monospace;
font-size:14px;
padding-top:4px;
margin-top:8px;
line-height:1.4em;
}
dt code {
font-family:'DejaVu Sans Mono', monospace;
font-size:14px;
padding-top:4px;
}
table tr td dt code {
font-family:'DejaVu Sans Mono', monospace;
font-size:14px;
vertical-align:top;
padding-top:4px;
}
sup {
font-size:8px;
}
/*
Document title and Copyright styles
*/
.clear {
clear:both;
height:0px;
overflow:hidden;
}
.aboutLanguage {
float:right;
padding:0px 21px;
font-size:11px;
z-index:200;
margin-top:-9px;
}
.legalCopy {
margin-left:.5em;
}
.bar a, .bar a:link, .bar a:visited, .bar a:active {
color:#FFFFFF;
text-decoration:none;
}
.bar a:hover, .bar a:focus {
color:#bb7a2a;
}
.tab {
background-color:#0066FF;
color:#ffffff;
padding:8px;
width:5em;
font-weight:bold;
}
/*
Navigation bar styles
*/
.bar {
background-color:#4D7A97;
color:#FFFFFF;
padding:.8em .5em .4em .8em;
height:auto;/*height:1.8em;*/
font-size:11px;
margin:0;
}
.topNav {
background-color:#4D7A97;
color:#FFFFFF;
float:left;
padding:0;
width:100%;
clear:right;
height:2.8em;
padding-top:10px;
overflow:hidden;
font-size:12px;
}
.bottomNav {
margin-top:10px;
background-color:#4D7A97;
color:#FFFFFF;
float:left;
padding:0;
width:100%;
clear:right;
height:2.8em;
padding-top:10px;
overflow:hidden;
font-size:12px;
}
.subNav {
background-color:#dee3e9;
float:left;
width:100%;
overflow:hidden;
font-size:12px;
}
.subNav div {
clear:left;
float:left;
padding:0 0 5px 6px;
text-transform:uppercase;
}
ul.navList, ul.subNavList {
float:left;
margin:0 25px 0 0;
padding:0;
}
ul.navList li{
list-style:none;
float:left;
padding: 5px 6px;
text-transform:uppercase;
}
ul.subNavList li{
list-style:none;
float:left;
}
.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited {
color:#FFFFFF;
text-decoration:none;
text-transform:uppercase;
}
.topNav a:hover, .bottomNav a:hover {
text-decoration:none;
color:#bb7a2a;
text-transform:uppercase;
}
.navBarCell1Rev {
background-color:#F8981D;
color:#253441;
margin: auto 5px;
}
.skipNav {
position:absolute;
top:auto;
left:-9999px;
overflow:hidden;
}
/*
Page header and footer styles
*/
.header, .footer {
clear:both;
margin:0 20px;
padding:5px 0 0 0;
}
.indexHeader {
margin:10px;
position:relative;
}
.indexHeader span{
margin-right:15px;
}
.indexHeader h1 {
font-size:13px;
}
.title {
color:#2c4557;
margin:10px 0;
}
.subTitle {
margin:5px 0 0 0;
}
.header ul {
margin:0 0 15px 0;
padding:0;
}
.footer ul {
margin:20px 0 5px 0;
}
.header ul li, .footer ul li {
list-style:none;
font-size:13px;
}
/*
Heading styles
*/
div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 {
background-color:#dee3e9;
border:1px solid #d0d9e0;
margin:0 0 6px -8px;
padding:7px 5px;
}
ul.blockList ul.blockList ul.blockList li.blockList h3 {
background-color:#dee3e9;
border:1px solid #d0d9e0;
margin:0 0 6px -8px;
padding:7px 5px;
}
ul.blockList ul.blockList li.blockList h3 {
padding:0;
margin:15px 0;
}
ul.blockList li.blockList h2 {
padding:0px 0 20px 0;
}
/*
Page layout container styles
*/
.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer {
clear:both;
padding:10px 20px;
position:relative;
}
.indexContainer {
margin:10px;
position:relative;
font-size:12px;
}
.indexContainer h2 {
font-size:13px;
padding:0 0 3px 0;
}
.indexContainer ul {
margin:0;
padding:0;
}
.indexContainer ul li {
list-style:none;
padding-top:2px;
}
.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt {
font-size:12px;
font-weight:bold;
margin:10px 0 0 0;
color:#4E4E4E;
}
.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd {
margin:5px 0 10px 0px;
font-size:14px;
font-family:'DejaVu Sans Mono',monospace;
}
.serializedFormContainer dl.nameValue dt {
margin-left:1px;
font-size:1.1em;
display:inline;
font-weight:bold;
}
.serializedFormContainer dl.nameValue dd {
margin:0 0 0 1px;
font-size:1.1em;
display:inline;
}
/*
List styles
*/
ul.horizontal li {
display:inline;
font-size:0.9em;
}
ul.inheritance {
margin:0;
padding:0;
}
ul.inheritance li {
display:inline;
list-style:none;
}
ul.inheritance li ul.inheritance {
margin-left:15px;
padding-left:15px;
padding-top:1px;
}
ul.blockList, ul.blockListLast {
margin:10px 0 10px 0;
padding:0;
}
ul.blockList li.blockList, ul.blockListLast li.blockList {
list-style:none;
margin-bottom:15px;
line-height:1.4;
}
ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList {
padding:0px 20px 5px 10px;
border:1px solid #ededed;
background-color:#f8f8f8;
}
ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList {
padding:0 0 5px 8px;
background-color:#ffffff;
border:none;
}
ul.blockList ul.blockList ul.blockList ul.blockList li.blockList {
margin-left:0;
padding-left:0;
padding-bottom:15px;
border:none;
}
ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast {
list-style:none;
border-bottom:none;
padding-bottom:0;
}
table tr td dl, table tr td dl dt, table tr td dl dd {
margin-top:0;
margin-bottom:1px;
}
/*
Table styles
*/
.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary {
width:100%;
border-left:1px solid #EEE;
border-right:1px solid #EEE;
border-bottom:1px solid #EEE;
}
.overviewSummary, .memberSummary {
padding:0px;
}
.overviewSummary caption, .memberSummary caption, .typeSummary caption,
.useSummary caption, .constantsSummary caption, .deprecatedSummary caption {
position:relative;
text-align:left;
background-repeat:no-repeat;
color:#253441;
font-weight:bold;
clear:none;
overflow:hidden;
padding:0px;
padding-top:10px;
padding-left:1px;
margin:0px;
white-space:pre;
}
.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link,
.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link,
.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover,
.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover,
.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active,
.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active,
.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited,
.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited {
color:#FFFFFF;
}
.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span,
.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span {
white-space:nowrap;
padding-top:5px;
padding-left:12px;
padding-right:12px;
padding-bottom:7px;
display:inline-block;
float:left;
background-color:#F8981D;
border: none;
height:16px;
}
.memberSummary caption span.activeTableTab span {
white-space:nowrap;
padding-top:5px;
padding-left:12px;
padding-right:12px;
margin-right:3px;
display:inline-block;
float:left;
background-color:#F8981D;
height:16px;
}
.memberSummary caption span.tableTab span {
white-space:nowrap;
padding-top:5px;
padding-left:12px;
padding-right:12px;
margin-right:3px;
display:inline-block;
float:left;
background-color:#4D7A97;
height:16px;
}
.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab {
padding-top:0px;
padding-left:0px;
padding-right:0px;
background-image:none;
float:none;
display:inline;
}
.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd,
.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd {
display:none;
width:5px;
position:relative;
float:left;
background-color:#F8981D;
}
.memberSummary .activeTableTab .tabEnd {
display:none;
width:5px;
margin-right:3px;
position:relative;
float:left;
background-color:#F8981D;
}
.memberSummary .tableTab .tabEnd {
display:none;
width:5px;
margin-right:3px;
position:relative;
background-color:#4D7A97;
float:left;
}
.overviewSummary td, .memberSummary td, .typeSummary td,
.useSummary td, .constantsSummary td, .deprecatedSummary td {
text-align:left;
padding:0px 0px 12px 10px;
}
th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th,
td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{
vertical-align:top;
padding-right:0px;
padding-top:8px;
padding-bottom:3px;
}
th.colFirst, th.colLast, th.colOne, .constantsSummary th {
background:#dee3e9;
text-align:left;
padding:8px 3px 3px 7px;
}
td.colFirst, th.colFirst {
white-space:nowrap;
font-size:13px;
}
td.colLast, th.colLast {
font-size:13px;
}
td.colOne, th.colOne {
font-size:13px;
}
.overviewSummary td.colFirst, .overviewSummary th.colFirst,
.useSummary td.colFirst, .useSummary th.colFirst,
.overviewSummary td.colOne, .overviewSummary th.colOne,
.memberSummary td.colFirst, .memberSummary th.colFirst,
.memberSummary td.colOne, .memberSummary th.colOne,
.typeSummary td.colFirst{
width:25%;
vertical-align:top;
}
td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover {
font-weight:bold;
}
.tableSubHeadingColor {
background-color:#EEEEFF;
}
.altColor {
background-color:#FFFFFF;
}
.rowColor {
background-color:#EEEEEF;
}
/*
Content styles
*/
.description pre {
margin-top:0;
}
.deprecatedContent {
margin:0;
padding:10px 0;
}
.docSummary {
padding:0;
}
ul.blockList ul.blockList ul.blockList li.blockList h3 {
font-style:normal;
}
div.block {
font-size:14px;
font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
}
td.colLast div {
padding-top:0px;
}
td.colLast a {
padding-bottom:3px;
}
/*
Formatting effect styles
*/
.sourceLineNo {
color:green;
padding:0 30px 0 0;
}
h1.hidden {
visibility:hidden;
overflow:hidden;
font-size:10px;
}
.block {
display:block;
margin:3px 10px 2px 0px;
color:#474747;
}
.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink,
.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel,
.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink {
font-weight:bold;
}
.deprecationComment, .emphasizedPhrase, .interfaceName {
font-style:italic;
}
div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase,
div.block div.block span.interfaceName {
font-style:normal;
}
div.contentContainer ul.blockList li.blockList h2{
padding-bottom:0px;
}