Google Git
Sign in
apache / mina-site / refs/heads/mina-gen-docs / . / 1.1.6 / apidocs / org / apache / mina / transport / socket / nio / SocketSessionConfig.html
blob: 4f7c091f12aabfc9f0e593aef3a42997981dc576 [file] [log] [blame]
<!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_191) on Sat Mar 16 10:17:08 CET 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SocketSessionConfig (Apache MINA 1.1.6 API Documentation)</title>
<meta name="date" content="2019-03-16">
<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="SocketSessionConfig (Apache MINA 1.1.6 API Documentation)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SocketSessionConfig.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/mina/transport/socket/nio/SocketConnectorConfig.html" title="class in org.apache.mina.transport.socket.nio"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/mina/transport/socket/nio/SocketSessionConfigImpl.html" title="class in org.apache.mina.transport.socket.nio"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/mina/transport/socket/nio/SocketSessionConfig.html" target="_top">Frames</a></li>
<li><a href="SocketSessionConfig.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.mina.transport.socket.nio</div>
<h2 title="Interface SocketSessionConfig" class="title">Interface SocketSessionConfig</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../../org/apache/mina/common/IoSessionConfig.html" title="interface in org.apache.mina.common">IoSessionConfig</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/mina/transport/socket/nio/SocketSessionConfigImpl.html" title="class in org.apache.mina.transport.socket.nio">SocketSessionConfigImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">SocketSessionConfig</span>
extends <a href="../../../../../../org/apache/mina/common/IoSessionConfig.html" title="interface in org.apache.mina.common">IoSessionConfig</a></pre>
<div class="block">An <a href="../../../../../../org/apache/mina/common/IoSessionConfig.html" title="interface in org.apache.mina.common"><code>IoSessionConfig</code></a> for socket transport type.</div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>$Rev: 555855 $, $Date: 2007-07-13 05:19:00 +0200 (Fri, 13 Jul 2007) $</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>The Apache Directory Project (mina-dev@directory.apache.org)</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/SocketSessionConfig.html#getReceiveBufferSize--">getReceiveBufferSize</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/SocketSessionConfig.html#getSendBufferSize--">getSendBufferSize</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/SocketSessionConfig.html#getSoLinger--">getSoLinger</a></span>()</code>
<div class="block">Please note that enabling <tt>SO_LINGER</tt> in Java NIO can result
in platform-dependent behavior and unexpected blocking of I/O thread.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/SocketSessionConfig.html#getTrafficClass--">getTrafficClass</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/SocketSessionConfig.html#isKeepAlive--">isKeepAlive</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/SocketSessionConfig.html#isOobInline--">isOobInline</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/SocketSessionConfig.html#isReuseAddress--">isReuseAddress</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/SocketSessionConfig.html#isTcpNoDelay--">isTcpNoDelay</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/SocketSessionConfig.html#setKeepAlive-boolean-">setKeepAlive</a></span>(boolean&nbsp;keepAlive)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/SocketSessionConfig.html#setOobInline-boolean-">setOobInline</a></span>(boolean&nbsp;oobInline)</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/SocketSessionConfig.html#setReceiveBufferSize-int-">setReceiveBufferSize</a></span>(int&nbsp;receiveBufferSize)</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/SocketSessionConfig.html#setReuseAddress-boolean-">setReuseAddress</a></span>(boolean&nbsp;reuseAddress)</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/SocketSessionConfig.html#setSendBufferSize-int-">setSendBufferSize</a></span>(int&nbsp;sendBufferSize)</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/SocketSessionConfig.html#setSoLinger-int-">setSoLinger</a></span>(int&nbsp;soLinger)</code>
<div class="block">Please note that enabling <tt>SO_LINGER</tt> in Java NIO can result
in platform-dependent behavior and unexpected blocking of I/O thread.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/SocketSessionConfig.html#setTcpNoDelay-boolean-">setTcpNoDelay</a></span>(boolean&nbsp;tcpNoDelay)</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/SocketSessionConfig.html#setTrafficClass-int-">setTrafficClass</a></span>(int&nbsp;trafficClass)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.mina.common.IoSessionConfig">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.mina.common.<a href="../../../../../../org/apache/mina/common/IoSessionConfig.html" title="interface in org.apache.mina.common">IoSessionConfig</a></h3>
<code><a href="../../../../../../org/apache/mina/common/IoSessionConfig.html#clone--">clone</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isReuseAddress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isReuseAddress</h4>
<pre>boolean&nbsp;isReuseAddress()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Socket.getReuseAddress()</code></dd>
</dl>
</li>
</ul>
<a name="setReuseAddress-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReuseAddress</h4>
<pre>void&nbsp;setReuseAddress(boolean&nbsp;reuseAddress)</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Socket.setReuseAddress(boolean)</code></dd>
</dl>
</li>
</ul>
<a name="getReceiveBufferSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReceiveBufferSize</h4>
<pre>int&nbsp;getReceiveBufferSize()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Socket.getReceiveBufferSize()</code></dd>
</dl>
</li>
</ul>
<a name="setReceiveBufferSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReceiveBufferSize</h4>
<pre>void&nbsp;setReceiveBufferSize(int&nbsp;receiveBufferSize)</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Socket.setReceiveBufferSize(int)</code></dd>
</dl>
</li>
</ul>
<a name="getSendBufferSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSendBufferSize</h4>
<pre>int&nbsp;getSendBufferSize()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Socket.getSendBufferSize()</code></dd>
</dl>
</li>
</ul>
<a name="setSendBufferSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSendBufferSize</h4>
<pre>void&nbsp;setSendBufferSize(int&nbsp;sendBufferSize)</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Socket.setSendBufferSize(int)</code></dd>
</dl>
</li>
</ul>
<a name="getTrafficClass--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTrafficClass</h4>
<pre>int&nbsp;getTrafficClass()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Socket.getTrafficClass()</code></dd>
</dl>
</li>
</ul>
<a name="setTrafficClass-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTrafficClass</h4>
<pre>void&nbsp;setTrafficClass(int&nbsp;trafficClass)</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Socket.setTrafficClass(int)</code></dd>
</dl>
</li>
</ul>
<a name="isKeepAlive--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isKeepAlive</h4>
<pre>boolean&nbsp;isKeepAlive()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Socket.getKeepAlive()</code></dd>
</dl>
</li>
</ul>
<a name="setKeepAlive-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setKeepAlive</h4>
<pre>void&nbsp;setKeepAlive(boolean&nbsp;keepAlive)</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Socket.setKeepAlive(boolean)</code></dd>
</dl>
</li>
</ul>
<a name="isOobInline--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOobInline</h4>
<pre>boolean&nbsp;isOobInline()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Socket.getOOBInline()</code></dd>
</dl>
</li>
</ul>
<a name="setOobInline-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOobInline</h4>
<pre>void&nbsp;setOobInline(boolean&nbsp;oobInline)</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Socket.setOOBInline(boolean)</code></dd>
</dl>
</li>
</ul>
<a name="getSoLinger--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSoLinger</h4>
<pre>int&nbsp;getSoLinger()</pre>
<div class="block">Please note that enabling <tt>SO_LINGER</tt> in Java NIO can result
in platform-dependent behavior and unexpected blocking of I/O thread.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Socket.getSoLinger()</code>,
<a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6179351">Sun Bug Database</a></dd>
</dl>
</li>
</ul>
<a name="setSoLinger-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSoLinger</h4>
<pre>void&nbsp;setSoLinger(int&nbsp;soLinger)</pre>
<div class="block">Please note that enabling <tt>SO_LINGER</tt> in Java NIO can result
in platform-dependent behavior and unexpected blocking of I/O thread.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>soLinger</code> - Please specify a negative value to disable <tt>SO_LINGER</tt>.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Socket.setSoLinger(boolean, int)</code>,
<a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6179351">Sun Bug Database</a></dd>
</dl>
</li>
</ul>
<a name="isTcpNoDelay--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isTcpNoDelay</h4>
<pre>boolean&nbsp;isTcpNoDelay()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Socket.getTcpNoDelay()</code></dd>
</dl>
</li>
</ul>
<a name="setTcpNoDelay-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setTcpNoDelay</h4>
<pre>void&nbsp;setTcpNoDelay(boolean&nbsp;tcpNoDelay)</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Socket.setTcpNoDelay(boolean)</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SocketSessionConfig.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/mina/transport/socket/nio/SocketConnectorConfig.html" title="class in org.apache.mina.transport.socket.nio"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/mina/transport/socket/nio/SocketSessionConfigImpl.html" title="class in org.apache.mina.transport.socket.nio"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/mina/transport/socket/nio/SocketSessionConfig.html" target="_top">Frames</a></li>
<li><a href="SocketSessionConfig.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2004-2019 <a href="http://mina.apache.org/">Apache MINA Project</a>. All Rights Reserved.</small></p>
</body>
</html>