calmnetlib/JavaDoc/index-files/index-3.html

248 lines
20 KiB
HTML
Raw Normal View History

2023-05-23 15:24:10 +01:00
<!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>