833 lines
49 KiB
HTML
833 lines
49 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (1.8.0_262) on 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 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 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 Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="subTitle">com.captainalm.lib.calmnet.packet.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"> </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> factory,
|
|
<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a> loader,
|
|
com.captainalm.lib.stdcrypt.encryption.ICipherFactory 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> factory,
|
|
<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a> loader,
|
|
com.captainalm.lib.stdcrypt.encryption.ICipherFactory cipherFactory,
|
|
boolean 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> factory,
|
|
<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a> loader,
|
|
com.captainalm.lib.stdcrypt.encryption.ICipherFactory cipherFactory,
|
|
<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a> 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> factory,
|
|
<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a> loader,
|
|
com.captainalm.lib.stdcrypt.encryption.ICipherFactory cipherFactory,
|
|
<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a> packet,
|
|
boolean 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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Method and Description</th>
|
|
</tr>
|
|
<tr id="i0" class="altColor">
|
|
<td class="colFirst"><code>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[] 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 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 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 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> 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> 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> 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 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 inputStream,
|
|
int size)</code>
|
|
<div class="block">Writes payload data from an <code>InputStream</code>.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
|
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="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 EncryptedPacket(<a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a> factory,
|
|
<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a> loader,
|
|
com.captainalm.lib.stdcrypt.encryption.ICipherFactory 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 EncryptedPacket(<a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a> factory,
|
|
<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a> loader,
|
|
com.captainalm.lib.stdcrypt.encryption.ICipherFactory cipherFactory,
|
|
boolean 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 EncryptedPacket(<a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a> factory,
|
|
<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a> loader,
|
|
com.captainalm.lib.stdcrypt.encryption.ICipherFactory cipherFactory,
|
|
<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a> 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 EncryptedPacket(<a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a> factory,
|
|
<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a> loader,
|
|
com.captainalm.lib.stdcrypt.encryption.ICipherFactory cipherFactory,
|
|
<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a> packet,
|
|
boolean 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 boolean isValid()</pre>
|
|
<div class="block">Gets if the packet is valid.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#isValid--">isValid</a></code> in interface <code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Is the packet valid?</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getProtocol--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getProtocol</h4>
|
|
<pre>public <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a> getProtocol()</pre>
|
|
<div class="block">Gets the protocol information.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#getProtocol--">getProtocol</a></code> in interface <code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The protocol information.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getTheProtocol--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getTheProtocol</h4>
|
|
<pre>public static <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a> getTheProtocol()</pre>
|
|
<div class="block">Gets the protocol information statically.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The protocol information.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="savePayload--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>savePayload</h4>
|
|
<pre>public byte[] savePayload()
|
|
throws <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
|
|
<div class="block">Saves the packet payload to a byte array.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#savePayload--">savePayload</a></code> in interface <code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></code></dd>
|
|
<dt><span class="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 void loadPayload(byte[] 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> in interface <code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></code></dd>
|
|
<dt><span class="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 void readData(java.io.OutputStream outputStream)
|
|
throws java.io.IOException,
|
|
<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
|
|
<div class="block">Reads payload data to an <code>OutputStream</code>.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html#readData-java.io.OutputStream-">readData</a></code> in interface <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 void writeData(java.io.InputStream inputStream,
|
|
int size)
|
|
throws java.io.IOException,
|
|
<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
|
|
<div class="block">Writes payload data from an <code>InputStream</code>.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html#writeData-java.io.InputStream-int-">writeData</a></code> in interface <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 int getSize()
|
|
throws <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
|
|
<div class="block">Gets the size of the output data.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IStreamedPacket.html#getSize--">getSize</a></code> in interface <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 <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a> 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 void setPacketLoader(<a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketLoader.html" title="class in com.captainalm.lib.calmnet.packet">PacketLoader</a> 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 <a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a> 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 void setFactory(<a href="../../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a> 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 com.captainalm.lib.stdcrypt.encryption.ICipherFactory 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 void setCipherFactory(com.captainalm.lib.stdcrypt.encryption.ICipherFactory 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 java.lang.String 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 void setTrailingPassword(java.lang.String 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 <a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a> 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 void setHeldPacket(<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a> 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 boolean 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> in interface <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 void setCacheUsed(boolean 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> in interface <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 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 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 Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|