903 lines
51 KiB
HTML
903 lines
51 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 Sun Jun 11 02:31:49 BST 2023 -->
|
|
<title>NetMarshalServer</title>
|
|
<meta name="date" content="2023-06-11">
|
|
<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 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 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 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.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"> </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 socketIn,
|
|
<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,
|
|
<a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a> 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 socketIn,
|
|
<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,
|
|
<a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a> 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"> </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>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> packetIn,
|
|
boolean 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 remoteAddress,
|
|
int remotePort,
|
|
int 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<java.lang.Exception,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a>></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<<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>></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<<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#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<<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#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<<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>></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<java.lang.Exception,<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#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<java.net.Socket,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a>></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<java.lang.Exception,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a>> 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<<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>> 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<<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>> 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<<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>> 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<<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>> 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<java.lang.Exception,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>> 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<java.net.Socket,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a>> 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 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 NetMarshalServer(java.net.ServerSocket socketIn,
|
|
<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,
|
|
<a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a> 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 NetMarshalServer(java.net.DatagramSocket socketIn,
|
|
<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,
|
|
<a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a> 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 void 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 <a href="../../../../../com/captainalm/lib/calmnet/packet/factory/IPacketFactory.html" title="interface in com.captainalm.lib.calmnet.packet.factory">IPacketFactory</a> 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 <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 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 java.net.InetAddress 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 int 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 boolean 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 <a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a> 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 <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>[] 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 void broadcastPacket(<a href="../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a> packetIn,
|
|
boolean 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 void 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 void 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 java.util.function.BiConsumer<<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>> 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 void setReceiveBiConsumer(java.util.function.BiConsumer<<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>> 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 java.util.function.BiConsumer<java.lang.Exception,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>> 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 void setReceiveExceptionBiConsumer(java.util.function.BiConsumer<java.lang.Exception,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>> 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 java.util.function.BiConsumer<java.lang.Exception,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a>> 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 void setAcceptExceptionBiConsumer(java.util.function.BiConsumer<java.lang.Exception,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a>> 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 java.util.function.Consumer<<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>> 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 void setClosedConsumer(java.util.function.Consumer<<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>> 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 java.util.function.Consumer<<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>> 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 void setOpenedConsumer(java.util.function.Consumer<<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a>> 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 java.util.function.BiConsumer<<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>> 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 void setClientAcceptanceBiConsumer(java.util.function.BiConsumer<<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>> 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 java.util.function.BiConsumer<java.net.Socket,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a>> 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 void setSocketSetupBiConsumer(java.util.function.BiConsumer<java.net.Socket,<a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalServer.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalServer</a>> 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 <a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal">NetMarshalClient</a> connect(java.net.InetAddress remoteAddress,
|
|
int remotePort,
|
|
int 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 void 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> in interface <code>java.io.Closeable</code></dd>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code>close</code> in interface <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 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 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 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>
|