| <!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:06:16 CET 2019 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>IoAcceptor (Apache MINA 1.1.0 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="IoAcceptor (Apache MINA 1.1.0 API Documentation)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":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/IoAcceptor.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/IdleStatus.html" title="class in org.apache.mina.common"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/mina/common/IoAcceptorConfig.html" title="interface in org.apache.mina.common"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/mina/common/IoAcceptor.html" target="_top">Frames</a></li> |
| <li><a href="IoAcceptor.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 IoAcceptor" class="title">Interface IoAcceptor</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/IoService.html" title="interface in org.apache.mina.common">IoService</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd>org.apache.mina.common.support.BaseIoAcceptor, <a href="../../../../org/apache/mina/transport/socket/nio/DatagramAcceptor.html" title="class in org.apache.mina.transport.socket.nio">DatagramAcceptor</a>, org.apache.mina.common.support.DelegatedIoAcceptor, <a href="../../../../org/apache/mina/transport/socket/nio/SocketAcceptor.html" title="class in org.apache.mina.transport.socket.nio">SocketAcceptor</a>, <a href="../../../../org/apache/mina/transport/vmpipe/VmPipeAcceptor.html" title="class in org.apache.mina.transport.vmpipe">VmPipeAcceptor</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">IoAcceptor</span> |
| extends <a href="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common">IoService</a></pre> |
| <div class="block">Accepts incoming connection, communicates with clients, and fires events to |
| <a href="../../../../org/apache/mina/common/IoHandler.html" title="interface in org.apache.mina.common"><code>IoHandler</code></a>s. |
| <p> |
| Please refer to |
| <a href="../../../../../xref-examples/org/apache/mina/examples/echoserver/Main.html">EchoServer</a> |
| example. |
| <p> |
| You should bind to the desired socket address to accept incoming |
| connections, and then events for incoming connections will be sent to |
| the specified default <a href="../../../../org/apache/mina/common/IoHandler.html" title="interface in org.apache.mina.common"><code>IoHandler</code></a>. |
| <p> |
| Threads accept incoming connections start automatically when |
| <a href="../../../../org/apache/mina/common/IoAcceptor.html#bind-java.net.SocketAddress-org.apache.mina.common.IoHandler-"><code>bind(SocketAddress, IoHandler)</code></a> is invoked, and stop when all |
| addresses are unbound.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Version:</span></dt> |
| <dd>$Rev: 440315 $, $Date: 2006-09-05 12:14:53 +0200 (Tue, 05 Sep 2006) $</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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="../../../../org/apache/mina/common/IoAcceptor.html#bind-java.net.SocketAddress-org.apache.mina.common.IoHandler-">bind</a></span>(java.net.SocketAddress address, |
| <a href="../../../../org/apache/mina/common/IoHandler.html" title="interface in org.apache.mina.common">IoHandler</a> handler)</code> |
| <div class="block">Binds to the specified <code>address</code> and handles incoming |
| connections with the specified <code>handler</code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoAcceptor.html#bind-java.net.SocketAddress-org.apache.mina.common.IoHandler-org.apache.mina.common.IoServiceConfig-">bind</a></span>(java.net.SocketAddress address, |
| <a href="../../../../org/apache/mina/common/IoHandler.html" title="interface in org.apache.mina.common">IoHandler</a> handler, |
| <a href="../../../../org/apache/mina/common/IoServiceConfig.html" title="interface in org.apache.mina.common">IoServiceConfig</a> config)</code> |
| <div class="block">Binds to the specified <code>address</code> and handles incoming |
| connections with the specified <code>handler</code>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoAcceptor.html#newSession-java.net.SocketAddress-java.net.SocketAddress-">newSession</a></span>(java.net.SocketAddress remoteAddress, |
| java.net.SocketAddress localAddress)</code> |
| <div class="block">(Optional) Returns an <a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><code>IoSession</code></a> that is bound to the specified |
| <tt>localAddress</tt> and <tt>remoteAddress</tt> which reuses |
| the <tt>localAddress</tt> that is already bound by <a href="../../../../org/apache/mina/common/IoAcceptor.html" title="interface in org.apache.mina.common"><code>IoAcceptor</code></a> |
| via <a href="../../../../org/apache/mina/common/IoAcceptor.html#bind-java.net.SocketAddress-org.apache.mina.common.IoHandler-"><code>bind(SocketAddress, IoHandler)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoAcceptor.html#unbind-java.net.SocketAddress-">unbind</a></span>(java.net.SocketAddress address)</code> |
| <div class="block">Unbinds from the specified <code>address</code> and disconnects all clients |
| connected there.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoAcceptor.html#unbindAll--">unbindAll</a></span>()</code> |
| <div class="block">Unbinds all addresses which were bound by this acceptor.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.mina.common.IoService"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.mina.common.<a href="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common">IoService</a></h3> |
| <code><a href="../../../../org/apache/mina/common/IoService.html#addListener-org.apache.mina.common.IoServiceListener-">addListener</a>, <a href="../../../../org/apache/mina/common/IoService.html#getDefaultConfig--">getDefaultConfig</a>, <a href="../../../../org/apache/mina/common/IoService.html#getFilterChain--">getFilterChain</a>, <a href="../../../../org/apache/mina/common/IoService.html#getFilterChainBuilder--">getFilterChainBuilder</a>, <a href="../../../../org/apache/mina/common/IoService.html#getManagedServiceAddresses--">getManagedServiceAddresses</a>, <a href="../../../../org/apache/mina/common/IoService.html#getManagedSessions-java.net.SocketAddress-">getManagedSessions</a>, <a href="../../../../org/apache/mina/common/IoService.html#isManaged-java.net.SocketAddress-">isManaged</a>, <a href="../../../../org/apache/mina/common/IoService.html#removeListener-org.apache.mina.common.IoServiceListener-">removeListener</a>, <a href="../../../../org/apache/mina/common/IoService.html#setFilterChainBuilder-org.apache.mina.common.IoFilterChainBuilder-">setFilterChainBuilder</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="bind-java.net.SocketAddress-org.apache.mina.common.IoHandler-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bind</h4> |
| <pre>void bind(java.net.SocketAddress address, |
| <a href="../../../../org/apache/mina/common/IoHandler.html" title="interface in org.apache.mina.common">IoHandler</a> handler) |
| throws java.io.IOException</pre> |
| <div class="block">Binds to the specified <code>address</code> and handles incoming |
| connections with the specified <code>handler</code>.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if failed to bind</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="bind-java.net.SocketAddress-org.apache.mina.common.IoHandler-org.apache.mina.common.IoServiceConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bind</h4> |
| <pre>void bind(java.net.SocketAddress address, |
| <a href="../../../../org/apache/mina/common/IoHandler.html" title="interface in org.apache.mina.common">IoHandler</a> handler, |
| <a href="../../../../org/apache/mina/common/IoServiceConfig.html" title="interface in org.apache.mina.common">IoServiceConfig</a> config) |
| throws java.io.IOException</pre> |
| <div class="block">Binds to the specified <code>address</code> and handles incoming |
| connections with the specified <code>handler</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>config</code> - the configuration</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if failed to bind</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="unbind-java.net.SocketAddress-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unbind</h4> |
| <pre>void unbind(java.net.SocketAddress address)</pre> |
| <div class="block">Unbinds from the specified <code>address</code> and disconnects all clients |
| connected there.</div> |
| </li> |
| </ul> |
| <a name="unbindAll--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unbindAll</h4> |
| <pre>void unbindAll()</pre> |
| <div class="block">Unbinds all addresses which were bound by this acceptor.</div> |
| </li> |
| </ul> |
| <a name="newSession-java.net.SocketAddress-java.net.SocketAddress-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>newSession</h4> |
| <pre><a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</a> newSession(java.net.SocketAddress remoteAddress, |
| java.net.SocketAddress localAddress)</pre> |
| <div class="block">(Optional) Returns an <a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><code>IoSession</code></a> that is bound to the specified |
| <tt>localAddress</tt> and <tt>remoteAddress</tt> which reuses |
| the <tt>localAddress</tt> that is already bound by <a href="../../../../org/apache/mina/common/IoAcceptor.html" title="interface in org.apache.mina.common"><code>IoAcceptor</code></a> |
| via <a href="../../../../org/apache/mina/common/IoAcceptor.html#bind-java.net.SocketAddress-org.apache.mina.common.IoHandler-"><code>bind(SocketAddress, IoHandler)</code></a>. |
| <p> |
| This operation is optional. Please throw <code>UnsupportedOperationException</code> |
| if the transport type doesn't support this operation. This operation is |
| usually implemented for connectionless transport types.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.UnsupportedOperationException</code> - if this operation is not supported</dd> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the specified <tt>localAddress</tt> is |
| not bound yet. (see <a href="../../../../org/apache/mina/common/IoAcceptor.html#bind-java.net.SocketAddress-org.apache.mina.common.IoHandler-"><code>bind(SocketAddress, IoHandler)</code></a>)</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/IoAcceptor.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/IdleStatus.html" title="class in org.apache.mina.common"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/mina/common/IoAcceptorConfig.html" title="interface in org.apache.mina.common"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/mina/common/IoAcceptor.html" target="_top">Frames</a></li> |
| <li><a href="IoAcceptor.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> |
