Google Git
Sign in
apache / mina-site / refs/heads/mina-gen-docs / . / 1.0.4 / apidocs / org / apache / mina / common / IoServiceConfig.html
blob: 710784b5eec6ed695845f5f963452a813bd2f0a9 [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 08:52:12 CET 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IoServiceConfig (Apache MINA 1.0.4 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="IoServiceConfig (Apache MINA 1.0.4 API Documentation)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":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/IoServiceConfig.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/common/IoService.html" title="interface in org.apache.mina.common"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/mina/common/IoServiceListener.html" title="interface in org.apache.mina.common"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/mina/common/IoServiceConfig.html" target="_top">Frames</a></li>
<li><a href="IoServiceConfig.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.common</div>
<h2 title="Interface IoServiceConfig" class="title">Interface IoServiceConfig</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../org/apache/mina/transport/socket/nio/DatagramServiceConfig.html" title="interface in org.apache.mina.transport.socket.nio">DatagramServiceConfig</a>, <a href="../../../../org/apache/mina/common/IoAcceptorConfig.html" title="interface in org.apache.mina.common">IoAcceptorConfig</a>, <a href="../../../../org/apache/mina/common/IoConnectorConfig.html" title="interface in org.apache.mina.common">IoConnectorConfig</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd>org.apache.mina.common.support.BaseIoAcceptorConfig, org.apache.mina.common.support.BaseIoConnectorConfig, org.apache.mina.common.support.BaseIoServiceConfig, <a href="../../../../org/apache/mina/transport/socket/nio/DatagramAcceptorConfig.html" title="class in org.apache.mina.transport.socket.nio">DatagramAcceptorConfig</a>, <a href="../../../../org/apache/mina/transport/socket/nio/DatagramConnectorConfig.html" title="class in org.apache.mina.transport.socket.nio">DatagramConnectorConfig</a>, <a href="../../../../org/apache/mina/transport/socket/nio/SocketAcceptorConfig.html" title="class in org.apache.mina.transport.socket.nio">SocketAcceptorConfig</a>, <a href="../../../../org/apache/mina/transport/socket/nio/SocketConnectorConfig.html" title="class in org.apache.mina.transport.socket.nio">SocketConnectorConfig</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">IoServiceConfig</span></pre>
<div class="block">A configuration which is used to configure <a href="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common"><code>IoService</code></a>.</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>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoServiceConfig.html#clone--">clone</a></span>()</code>
<div class="block">Returns a deep clone of this configuration.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/mina/common/DefaultIoFilterChainBuilder.html" title="class in org.apache.mina.common">DefaultIoFilterChainBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoServiceConfig.html#getFilterChain--">getFilterChain</a></span>()</code>
<div class="block">A shortcut for <tt>( ( DefaultIoFilterChainBuilder ) </tt><a href="../../../../org/apache/mina/common/IoServiceConfig.html#getFilterChainBuilder--"><code>getFilterChainBuilder()</code></a><tt> )</tt>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/mina/common/IoFilterChainBuilder.html" title="interface in org.apache.mina.common">IoFilterChainBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoServiceConfig.html#getFilterChainBuilder--">getFilterChainBuilder</a></span>()</code>
<div class="block">Returns the <a href="../../../../org/apache/mina/common/IoFilterChainBuilder.html" title="interface in org.apache.mina.common"><code>IoFilterChainBuilder</code></a> which will modify the
<a href="../../../../org/apache/mina/common/IoFilterChain.html" title="interface in org.apache.mina.common"><code>IoFilterChain</code></a> of all <a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><code>IoSession</code></a>s which is created
with this configuration.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/mina/common/IoSessionConfig.html" title="interface in org.apache.mina.common">IoSessionConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoServiceConfig.html#getSessionConfig--">getSessionConfig</a></span>()</code>
<div class="block">Resturns the default configuration of the new <a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><code>IoSession</code></a>s.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/mina/common/ThreadModel.html" title="interface in org.apache.mina.common">ThreadModel</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoServiceConfig.html#getThreadModel--">getThreadModel</a></span>()</code>
<div class="block">Returns the default <a href="../../../../org/apache/mina/common/ThreadModel.html" title="interface in org.apache.mina.common"><code>ThreadModel</code></a> of the <a href="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common"><code>IoService</code></a>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoServiceConfig.html#setFilterChainBuilder-org.apache.mina.common.IoFilterChainBuilder-">setFilterChainBuilder</a></span>(<a href="../../../../org/apache/mina/common/IoFilterChainBuilder.html" title="interface in org.apache.mina.common">IoFilterChainBuilder</a>&nbsp;builder)</code>
<div class="block">Sets the <a href="../../../../org/apache/mina/common/IoFilterChainBuilder.html" title="interface in org.apache.mina.common"><code>IoFilterChainBuilder</code></a> which will modify the
<a href="../../../../org/apache/mina/common/IoFilterChain.html" title="interface in org.apache.mina.common"><code>IoFilterChain</code></a> of all <a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><code>IoSession</code></a>s which is created
with this configuration.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoServiceConfig.html#setThreadModel-org.apache.mina.common.ThreadModel-">setThreadModel</a></span>(<a href="../../../../org/apache/mina/common/ThreadModel.html" title="interface in org.apache.mina.common">ThreadModel</a>&nbsp;threadModel)</code>
<div class="block">Sets the default <a href="../../../../org/apache/mina/common/ThreadModel.html" title="interface in org.apache.mina.common"><code>ThreadModel</code></a> of the <a href="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common"><code>IoService</code></a>.</div>
</td>
</tr>
</table>
</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="getSessionConfig--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSessionConfig</h4>
<pre><a href="../../../../org/apache/mina/common/IoSessionConfig.html" title="interface in org.apache.mina.common">IoSessionConfig</a>&nbsp;getSessionConfig()</pre>
<div class="block">Resturns the default configuration of the new <a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><code>IoSession</code></a>s.</div>
</li>
</ul>
<a name="getFilterChainBuilder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilterChainBuilder</h4>
<pre><a href="../../../../org/apache/mina/common/IoFilterChainBuilder.html" title="interface in org.apache.mina.common">IoFilterChainBuilder</a>&nbsp;getFilterChainBuilder()</pre>
<div class="block">Returns the <a href="../../../../org/apache/mina/common/IoFilterChainBuilder.html" title="interface in org.apache.mina.common"><code>IoFilterChainBuilder</code></a> which will modify the
<a href="../../../../org/apache/mina/common/IoFilterChain.html" title="interface in org.apache.mina.common"><code>IoFilterChain</code></a> of all <a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><code>IoSession</code></a>s which is created
with this configuration.
The default value is an empty <a href="../../../../org/apache/mina/common/DefaultIoFilterChainBuilder.html" title="class in org.apache.mina.common"><code>DefaultIoFilterChainBuilder</code></a>.</div>
</li>
</ul>
<a name="setFilterChainBuilder-org.apache.mina.common.IoFilterChainBuilder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFilterChainBuilder</h4>
<pre>void&nbsp;setFilterChainBuilder(<a href="../../../../org/apache/mina/common/IoFilterChainBuilder.html" title="interface in org.apache.mina.common">IoFilterChainBuilder</a>&nbsp;builder)</pre>
<div class="block">Sets the <a href="../../../../org/apache/mina/common/IoFilterChainBuilder.html" title="interface in org.apache.mina.common"><code>IoFilterChainBuilder</code></a> which will modify the
<a href="../../../../org/apache/mina/common/IoFilterChain.html" title="interface in org.apache.mina.common"><code>IoFilterChain</code></a> of all <a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><code>IoSession</code></a>s which is created
with this configuration.
If you specify <tt>null</tt> this property will be set to
an empty <a href="../../../../org/apache/mina/common/DefaultIoFilterChainBuilder.html" title="class in org.apache.mina.common"><code>DefaultIoFilterChainBuilder</code></a>.</div>
</li>
</ul>
<a name="getFilterChain--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilterChain</h4>
<pre><a href="../../../../org/apache/mina/common/DefaultIoFilterChainBuilder.html" title="class in org.apache.mina.common">DefaultIoFilterChainBuilder</a>&nbsp;getFilterChain()</pre>
<div class="block">A shortcut for <tt>( ( DefaultIoFilterChainBuilder ) </tt><a href="../../../../org/apache/mina/common/IoServiceConfig.html#getFilterChainBuilder--"><code>getFilterChainBuilder()</code></a><tt> )</tt>.
Please note that the returned object is not a <b>real</b> <a href="../../../../org/apache/mina/common/IoFilterChain.html" title="interface in org.apache.mina.common"><code>IoFilterChain</code></a>
but a <a href="../../../../org/apache/mina/common/DefaultIoFilterChainBuilder.html" title="class in org.apache.mina.common"><code>DefaultIoFilterChainBuilder</code></a>. Modifying the returned builder
won't affect the existing <a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><code>IoSession</code></a>s at all, because
<a href="../../../../org/apache/mina/common/IoFilterChainBuilder.html" title="interface in org.apache.mina.common"><code>IoFilterChainBuilder</code></a>s affect only newly created <a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><code>IoSession</code></a>s.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the current <a href="../../../../org/apache/mina/common/IoFilterChainBuilder.html" title="interface in org.apache.mina.common"><code>IoFilterChainBuilder</code></a> is
not a <a href="../../../../org/apache/mina/common/DefaultIoFilterChainBuilder.html" title="class in org.apache.mina.common"><code>DefaultIoFilterChainBuilder</code></a></dd>
</dl>
</li>
</ul>
<a name="getThreadModel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getThreadModel</h4>
<pre><a href="../../../../org/apache/mina/common/ThreadModel.html" title="interface in org.apache.mina.common">ThreadModel</a>&nbsp;getThreadModel()</pre>
<div class="block">Returns the default <a href="../../../../org/apache/mina/common/ThreadModel.html" title="interface in org.apache.mina.common"><code>ThreadModel</code></a> of the <a href="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common"><code>IoService</code></a>.
The default value is a <a href="../../../../org/apache/mina/common/ExecutorThreadModel.html" title="class in org.apache.mina.common"><code>ExecutorThreadModel</code></a>() whose service name is
<tt>'AnonymousIoService'</tt> and which has 16 maximum active threads.
It is strongly recommended to set a new <a href="../../../../org/apache/mina/common/ExecutorThreadModel.html" title="class in org.apache.mina.common"><code>ExecutorThreadModel</code></a> by calling
<a href="../../../../org/apache/mina/common/ExecutorThreadModel.html#getInstance-java.lang.String-"><code>ExecutorThreadModel.getInstance(String)</code></a>.</div>
</li>
</ul>
<a name="setThreadModel-org.apache.mina.common.ThreadModel-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setThreadModel</h4>
<pre>void&nbsp;setThreadModel(<a href="../../../../org/apache/mina/common/ThreadModel.html" title="interface in org.apache.mina.common">ThreadModel</a>&nbsp;threadModel)</pre>
<div class="block">Sets the default <a href="../../../../org/apache/mina/common/ThreadModel.html" title="interface in org.apache.mina.common"><code>ThreadModel</code></a> of the <a href="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common"><code>IoService</code></a>.
If you specify <tt>null</tt>, this property will be set to the
default value.
The default value is an <a href="../../../../org/apache/mina/common/ExecutorThreadModel.html" title="class in org.apache.mina.common"><code>ExecutorThreadModel</code></a> whose service name is
<tt>'AnonymousIoService'</tt> with 16 threads.
It is strongly recommended to set a new <a href="../../../../org/apache/mina/common/ExecutorThreadModel.html" title="class in org.apache.mina.common"><code>ExecutorThreadModel</code></a> by calling
<a href="../../../../org/apache/mina/common/ExecutorThreadModel.html#getInstance-java.lang.String-"><code>ExecutorThreadModel.getInstance(String)</code></a>.</div>
</li>
</ul>
<a name="clone--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clone</h4>
<pre>java.lang.Object&nbsp;clone()</pre>
<div class="block">Returns a deep clone of this configuration.</div>
</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/IoServiceConfig.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/common/IoService.html" title="interface in org.apache.mina.common"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/mina/common/IoServiceListener.html" title="interface in org.apache.mina.common"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/mina/common/IoServiceConfig.html" target="_top">Frames</a></li>
<li><a href="IoServiceConfig.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.apace.org/">Apache MINA Project</a>. All Rights Reserved.</small></p>
</body>
</html>