alfred/calmnetlib
1
0
Fork 0
Code Issues Pull Requests Projects Releases 2 Wiki Activity
da7a3cb976
calmnetlib/JavaDoc/com/captainalm/lib/calmnet/marshal/FragmentationOptions.html

463 lines
21 KiB
HTML
Raw Normal View History

Add build artifact and JavaDoc.
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>
Allow integer to bytes writing in PacketLoader to support negatives. Fix up JavaDoc.
2023-06-11 02:54:23 +01:00
<!-- Generated by javadoc (1.8.0_262) on Sun Jun 11 02:31:49 BST 2023 -->
Add build artifact and JavaDoc.
2023-05-23 15:24:10 +01:00
<title>FragmentationOptions</title>
Allow integer to bytes writing in PacketLoader to support negatives. Fix up JavaDoc.
2023-06-11 02:54:23 +01:00
<meta name="date" content="2023-06-11">
Add build artifact and JavaDoc.
2023-05-23 15:24:10 +01:00
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="FragmentationOptions";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../com/captainalm/lib/calmnet/marshal/CandidateClient.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" target="_top">Frames</a></li>
<li><a href="FragmentationOptions.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.captainalm.lib.calmnet.marshal</div>
<h2 title="Class FragmentationOptions" class="title">Class FragmentationOptions</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.marshal.FragmentationOptions</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">FragmentationOptions</span>
extends java.lang.Object</pre>
<div class="block">This class provides fragmentation options for using <a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentSender</code></a>s and
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentReceiver</code></a>s in this package.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Captain ALM</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#emptySendsTillForced">emptySendsTillForced</a></span></code>
<div class="block">See:
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setNumberOfEmptySendsTillForcedCompleteOrResend-int-"><code>FragmentReceiver.setNumberOfEmptySendsTillForcedCompleteOrResend(int)</code></a></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#equalityVerifyFragments">equalityVerifyFragments</a></span></code>
<div class="block">See:
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#setSentDataWillBeAllVerified-boolean-"><code>FragmentSender.setSentDataWillBeAllVerified(boolean)</code></a> ,
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setSentDataWillBeAllVerified-boolean-"><code>FragmentReceiver.setSentDataWillBeAllVerified(boolean)</code></a></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#fragmentationSplitSize">fragmentationSplitSize</a></span></code>
<div class="block">See:
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#setSplitSize-int-"><code>FragmentSender.setSplitSize(int)</code></a></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#maximumFragmentAge">maximumFragmentAge</a></span></code>
<div class="block">The maximum age of fragments for a specified packet in seconds before those fragments are purged.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#verifyFragments">verifyFragments</a></span></code>
<div class="block">See:
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#setResponseVerification-boolean-"><code>FragmentSender.setResponseVerification(boolean)</code></a> ,
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setResponseVerification-boolean-"><code>FragmentReceiver.setResponseVerification(boolean)</code></a></div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#FragmentationOptions--">FragmentationOptions</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#FragmentationOptions-com.captainalm.lib.calmnet.marshal.FragmentationOptions-">FragmentationOptions</a></span>(<a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a>&nbsp;toCopy)</code>
<div class="block">Creates a copy of the provided FragmentationOptions.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#setupReceiver-com.captainalm.lib.calmnet.packet.fragment.FragmentReceiver-">setupReceiver</a></span>(<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a>&nbsp;receiver)</code>
<div class="block">Sets-up the provided <a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentReceiver</code></a> with parameters.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#setupSender-com.captainalm.lib.calmnet.packet.fragment.FragmentSender-">setupSender</a></span>(<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a>&nbsp;sender)</code>
<div class="block">Sets-up the provided <a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentSender</code></a> with parameters.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html#validate--">validate</a></span>()</code>
<div class="block">Validates the parameters within this structure.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="maximumFragmentAge">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maximumFragmentAge</h4>
<pre>public&nbsp;int maximumFragmentAge</pre>
<div class="block">The maximum age of fragments for a specified packet in seconds before those fragments are purged.</div>
</li>
</ul>
<a name="fragmentationSplitSize">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fragmentationSplitSize</h4>
<pre>public&nbsp;int fragmentationSplitSize</pre>
<div class="block">See:
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#setSplitSize-int-"><code>FragmentSender.setSplitSize(int)</code></a></div>
</li>
</ul>
<a name="emptySendsTillForced">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>emptySendsTillForced</h4>
<pre>public&nbsp;int emptySendsTillForced</pre>
<div class="block">See:
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setNumberOfEmptySendsTillForcedCompleteOrResend-int-"><code>FragmentReceiver.setNumberOfEmptySendsTillForcedCompleteOrResend(int)</code></a></div>
</li>
</ul>
<a name="verifyFragments">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>verifyFragments</h4>
<pre>public&nbsp;boolean verifyFragments</pre>
<div class="block">See:
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#setResponseVerification-boolean-"><code>FragmentSender.setResponseVerification(boolean)</code></a> ,
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setResponseVerification-boolean-"><code>FragmentReceiver.setResponseVerification(boolean)</code></a></div>
</li>
</ul>
<a name="equalityVerifyFragments">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>equalityVerifyFragments</h4>
<pre>public&nbsp;boolean equalityVerifyFragments</pre>
<div class="block">See:
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html#setSentDataWillBeAllVerified-boolean-"><code>FragmentSender.setSentDataWillBeAllVerified(boolean)</code></a> ,
<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html#setSentDataWillBeAllVerified-boolean-"><code>FragmentReceiver.setSentDataWillBeAllVerified(boolean)</code></a></div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="FragmentationOptions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FragmentationOptions</h4>
<pre>public&nbsp;FragmentationOptions()</pre>
</li>
</ul>
<a name="FragmentationOptions-com.captainalm.lib.calmnet.marshal.FragmentationOptions-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FragmentationOptions</h4>
<pre>public&nbsp;FragmentationOptions(<a href="../../../../../com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" title="class in com.captainalm.lib.calmnet.marshal">FragmentationOptions</a>&nbsp;toCopy)</pre>
<div class="block">Creates a copy of the provided FragmentationOptions.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>toCopy</code> - The options to copy.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - toCopy is null.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="validate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validate</h4>
<pre>public&nbsp;void&nbsp;validate()</pre>
<div class="block">Validates the parameters within this structure.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - maximumFragmentAge is less than 2, fragmentationSplitSize is less than 1 or emptySendsTillForced is less than 1.</dd>
</dl>
</li>
</ul>
<a name="setupSender-com.captainalm.lib.calmnet.packet.fragment.FragmentSender-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setupSender</h4>
<pre>public&nbsp;void&nbsp;setupSender(<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentSender</a>&nbsp;sender)</pre>
<div class="block">Sets-up the provided <a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentSender.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentSender</code></a> with parameters.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sender</code> - The sender to set up.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - A parameter is incorrect.</dd>
</dl>
</li>
</ul>
<a name="setupReceiver-com.captainalm.lib.calmnet.packet.fragment.FragmentReceiver-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setupReceiver</h4>
<pre>public&nbsp;void&nbsp;setupReceiver(<a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentReceiver</a>&nbsp;receiver)</pre>
<div class="block">Sets-up the provided <a href="../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentReceiver.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><code>FragmentReceiver</code></a> with parameters.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>receiver</code> - The receiver to set up.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - A parameter is incorrect.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../com/captainalm/lib/calmnet/marshal/CandidateClient.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/captainalm/lib/calmnet/marshal/NetMarshalClient.html" title="class in com.captainalm.lib.calmnet.marshal"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/marshal/FragmentationOptions.html" target="_top">Frames</a></li>
<li><a href="FragmentationOptions.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue Copy Permalink