| <!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 19:48:08 CET 2019 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>IoAcceptor (Apache MINA 2.0.0-M4 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 2.0.0-M4 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,"i16":6,"i17":6,"i18":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/core/service/DefaultTransportMetadata.html" title="class in org.apache.mina.core.service"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/mina/core/service/IoConnector.html" title="interface in org.apache.mina.core.service"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/mina/core/service/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.core.service</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/core/service/IoService.html" title="interface in org.apache.mina.core.service">IoService</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/mina/transport/socket/DatagramAcceptor.html" title="interface in org.apache.mina.transport.socket">DatagramAcceptor</a>, <a href="../../../../../org/apache/mina/transport/socket/SocketAcceptor.html" title="interface in org.apache.mina.transport.socket">SocketAcceptor</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/mina/core/service/AbstractIoAcceptor.html" title="class in org.apache.mina.core.service">AbstractIoAcceptor</a>, <a href="../../../../../org/apache/mina/core/polling/AbstractPollingConnectionlessIoAcceptor.html" title="class in org.apache.mina.core.polling">AbstractPollingConnectionlessIoAcceptor</a>, <a href="../../../../../org/apache/mina/core/polling/AbstractPollingIoAcceptor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoAcceptor</a>, <a href="../../../../../org/apache/mina/transport/socket/apr/AprSocketAcceptor.html" title="class in org.apache.mina.transport.socket.apr">AprSocketAcceptor</a>, <a href="../../../../../org/apache/mina/transport/socket/nio/NioDatagramAcceptor.html" title="class in org.apache.mina.transport.socket.nio">NioDatagramAcceptor</a>, <a href="../../../../../org/apache/mina/transport/socket/nio/NioSocketAcceptor.html" title="class in org.apache.mina.transport.socket.nio">NioSocketAcceptor</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/core/service/IoService.html" title="interface in org.apache.mina.core.service">IoService</a></pre> |
| <div class="block">Accepts incoming connection, communicates with clients, and fires events to |
| <a href="../../../../../org/apache/mina/core/service/IoHandler.html" title="interface in org.apache.mina.core.service"><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/core/service/IoHandler.html" title="interface in org.apache.mina.core.service"><code>IoHandler</code></a>. |
| <p> |
| Threads accept incoming connections start automatically when |
| <a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#bind--"><code>bind()</code></a> is invoked, and stop when <a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#unbind--"><code>unbind()</code></a> is invoked.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Version:</span></dt> |
| <dd>$Rev: 671827 $, $Date: 2008-06-26 10:49:48 +0200 (Thu, 26 Jun 2008) $</dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>The Apache MINA Project (dev@mina.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/core/service/IoAcceptor.html#bind--">bind</a></span>()</code> |
| <div class="block">Binds to the default local address(es) and start to accept incoming |
| connections.</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/core/service/IoAcceptor.html#bind-java.lang.Iterable-">bind</a></span>(java.lang.Iterable<? extends java.net.SocketAddress> localAddresses)</code> |
| <div class="block">Binds to the specified local addresses and start to accept incoming |
| connections.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#bind-java.net.SocketAddress-">bind</a></span>(java.net.SocketAddress localAddress)</code> |
| <div class="block">Binds to the specified local address and start to accept incoming |
| connections.</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/core/service/IoAcceptor.html#bind-java.net.SocketAddress-java.net.SocketAddress...-">bind</a></span>(java.net.SocketAddress firstLocalAddress, |
| java.net.SocketAddress... otherLocalAddresses)</code> |
| <div class="block">Binds to the specified local addresses and start to accept incoming |
| connections.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.net.SocketAddress</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#getDefaultLocalAddress--">getDefaultLocalAddress</a></span>()</code> |
| <div class="block">Returns the default local address to bind when no argument is specified |
| in <a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#bind--"><code>bind()</code></a> method.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<java.net.SocketAddress></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#getDefaultLocalAddresses--">getDefaultLocalAddresses</a></span>()</code> |
| <div class="block">Returns a <code>List</code> of the default local addresses to bind when no |
| argument is specified in <a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#bind--"><code>bind()</code></a> method.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.net.SocketAddress</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#getLocalAddress--">getLocalAddress</a></span>()</code> |
| <div class="block">Returns the local address which is bound currently.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>java.util.Set<java.net.SocketAddress></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#getLocalAddresses--">getLocalAddresses</a></span>()</code> |
| <div class="block">Returns a <code>Set</code> of the local addresses which are bound currently.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#isCloseOnDeactivation--">isCloseOnDeactivation</a></span>()</code> |
| <div class="block">Returns <tt>true</tt> if and only if all clients are closed when this |
| acceptor unbinds from all the related local address (i.e. when the |
| service is deactivated).</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/core/service/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/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a> that is bound to the specified |
| <tt>localAddress</tt> and the specified <tt>remoteAddress</tt> which |
| reuses the local address that is already bound by this service.</div> |
| </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/core/service/IoAcceptor.html#setCloseOnDeactivation-boolean-">setCloseOnDeactivation</a></span>(boolean closeOnDeactivation)</code> |
| <div class="block">Sets whether all client sessions are closed when this acceptor unbinds |
| from all the related local addresses (i.e. when the service is |
| deactivated).</div> |
| </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/core/service/IoAcceptor.html#setDefaultLocalAddress-java.net.SocketAddress-">setDefaultLocalAddress</a></span>(java.net.SocketAddress localAddress)</code> |
| <div class="block">Sets the default local address to bind when no argument is specified in |
| <a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#bind--"><code>bind()</code></a> method.</div> |
| </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/core/service/IoAcceptor.html#setDefaultLocalAddresses-java.lang.Iterable-">setDefaultLocalAddresses</a></span>(java.lang.Iterable<? extends java.net.SocketAddress> localAddresses)</code> |
| <div class="block">Sets the default local addresses to bind when no argument is specified |
| in <a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#bind--"><code>bind()</code></a> method.</div> |
| </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/core/service/IoAcceptor.html#setDefaultLocalAddresses-java.util.List-">setDefaultLocalAddresses</a></span>(java.util.List<? extends java.net.SocketAddress> localAddresses)</code> |
| <div class="block">Sets the default local addresses to bind when no argument is specified |
| in <a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#bind--"><code>bind()</code></a> method.</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/core/service/IoAcceptor.html#setDefaultLocalAddresses-java.net.SocketAddress-java.net.SocketAddress...-">setDefaultLocalAddresses</a></span>(java.net.SocketAddress firstLocalAddress, |
| java.net.SocketAddress... otherLocalAddresses)</code> |
| <div class="block">Sets the default local addresses to bind when no argument is specified |
| in <a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#bind--"><code>bind()</code></a> method.</div> |
| </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/core/service/IoAcceptor.html#unbind--">unbind</a></span>()</code> |
| <div class="block">Unbinds from all local addresses that this service is bound to and stops |
| to accept incoming connections.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#unbind-java.lang.Iterable-">unbind</a></span>(java.lang.Iterable<? extends java.net.SocketAddress> localAddresses)</code> |
| <div class="block">Unbinds from the specified local addresses and stop to accept incoming |
| connections.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#unbind-java.net.SocketAddress-">unbind</a></span>(java.net.SocketAddress localAddress)</code> |
| <div class="block">Unbinds from the specified local address and stop to accept incoming |
| connections.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#unbind-java.net.SocketAddress-java.net.SocketAddress...-">unbind</a></span>(java.net.SocketAddress firstLocalAddress, |
| java.net.SocketAddress... otherLocalAddresses)</code> |
| <div class="block">Unbinds from the specified local addresses and stop to accept incoming |
| connections.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.mina.core.service.IoService"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.mina.core.service.<a href="../../../../../org/apache/mina/core/service/IoService.html" title="interface in org.apache.mina.core.service">IoService</a></h3> |
| <code><a href="../../../../../org/apache/mina/core/service/IoService.html#addListener-org.apache.mina.core.service.IoServiceListener-">addListener</a>, <a href="../../../../../org/apache/mina/core/service/IoService.html#broadcast-java.lang.Object-">broadcast</a>, <a href="../../../../../org/apache/mina/core/service/IoService.html#dispose--">dispose</a>, <a href="../../../../../org/apache/mina/core/service/IoService.html#getActivationTime--">getActivationTime</a>, <a href="../../../../../org/apache/mina/core/service/IoService.html#getFilterChain--">getFilterChain</a>, <a href="../../../../../org/apache/mina/core/service/IoService.html#getFilterChainBuilder--">getFilterChainBuilder</a>, <a href="../../../../../org/apache/mina/core/service/IoService.html#getHandler--">getHandler</a>, <a href="../../../../../org/apache/mina/core/service/IoService.html#getManagedSessionCount--">getManagedSessionCount</a>, <a href="../../../../../org/apache/mina/core/service/IoService.html#getManagedSessions--">getManagedSessions</a>, <a href="../../../../../org/apache/mina/core/service/IoService.html#getScheduledWriteBytes--">getScheduledWriteBytes</a>, <a href="../../../../../org/apache/mina/core/service/IoService.html#getScheduledWriteMessages--">getScheduledWriteMessages</a>, <a href="../../../../../org/apache/mina/core/service/IoService.html#getSessionConfig--">getSessionConfig</a>, <a href="../../../../../org/apache/mina/core/service/IoService.html#getSessionDataStructureFactory--">getSessionDataStructureFactory</a>, <a href="../../../../../org/apache/mina/core/service/IoService.html#getStatistics--">getStatistics</a>, <a href="../../../../../org/apache/mina/core/service/IoService.html#getTransportMetadata--">getTransportMetadata</a>, <a href="../../../../../org/apache/mina/core/service/IoService.html#isActive--">isActive</a>, <a href="../../../../../org/apache/mina/core/service/IoService.html#isDisposed--">isDisposed</a>, <a href="../../../../../org/apache/mina/core/service/IoService.html#isDisposing--">isDisposing</a>, <a href="../../../../../org/apache/mina/core/service/IoService.html#removeListener-org.apache.mina.core.service.IoServiceListener-">removeListener</a>, <a href="../../../../../org/apache/mina/core/service/IoService.html#setFilterChainBuilder-org.apache.mina.core.filterchain.IoFilterChainBuilder-">setFilterChainBuilder</a>, <a href="../../../../../org/apache/mina/core/service/IoService.html#setHandler-org.apache.mina.core.service.IoHandler-">setHandler</a>, <a href="../../../../../org/apache/mina/core/service/IoService.html#setSessionDataStructureFactory-org.apache.mina.core.session.IoSessionDataStructureFactory-">setSessionDataStructureFactory</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="getLocalAddress--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocalAddress</h4> |
| <pre>java.net.SocketAddress getLocalAddress()</pre> |
| <div class="block">Returns the local address which is bound currently. If more than one |
| address are bound, only one of them will be returned, but it's not |
| necessarily the firstly bound address.</div> |
| </li> |
| </ul> |
| <a name="getLocalAddresses--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocalAddresses</h4> |
| <pre>java.util.Set<java.net.SocketAddress> getLocalAddresses()</pre> |
| <div class="block">Returns a <code>Set</code> of the local addresses which are bound currently.</div> |
| </li> |
| </ul> |
| <a name="getDefaultLocalAddress--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultLocalAddress</h4> |
| <pre>java.net.SocketAddress getDefaultLocalAddress()</pre> |
| <div class="block">Returns the default local address to bind when no argument is specified |
| in <a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#bind--"><code>bind()</code></a> method. Please note that the default will not be |
| used if any local address is specified. If more than one address are |
| set, only one of them will be returned, but it's not necessarily the |
| firstly specified address in <a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#setDefaultLocalAddresses-java.util.List-"><code>setDefaultLocalAddresses(List)</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getDefaultLocalAddresses--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultLocalAddresses</h4> |
| <pre>java.util.List<java.net.SocketAddress> getDefaultLocalAddresses()</pre> |
| <div class="block">Returns a <code>List</code> of the default local addresses to bind when no |
| argument is specified in <a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#bind--"><code>bind()</code></a> method. Please note that the |
| default will not be used if any local address is specified.</div> |
| </li> |
| </ul> |
| <a name="setDefaultLocalAddress-java.net.SocketAddress-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDefaultLocalAddress</h4> |
| <pre>void setDefaultLocalAddress(java.net.SocketAddress localAddress)</pre> |
| <div class="block">Sets the default local address to bind when no argument is specified in |
| <a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#bind--"><code>bind()</code></a> method. Please note that the default will not be used |
| if any local address is specified.</div> |
| </li> |
| </ul> |
| <a name="setDefaultLocalAddresses-java.net.SocketAddress-java.net.SocketAddress...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDefaultLocalAddresses</h4> |
| <pre>void setDefaultLocalAddresses(java.net.SocketAddress firstLocalAddress, |
| java.net.SocketAddress... otherLocalAddresses)</pre> |
| <div class="block">Sets the default local addresses to bind when no argument is specified |
| in <a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#bind--"><code>bind()</code></a> method. Please note that the default will not be |
| used if any local address is specified.</div> |
| </li> |
| </ul> |
| <a name="setDefaultLocalAddresses-java.lang.Iterable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDefaultLocalAddresses</h4> |
| <pre>void setDefaultLocalAddresses(java.lang.Iterable<? extends java.net.SocketAddress> localAddresses)</pre> |
| <div class="block">Sets the default local addresses to bind when no argument is specified |
| in <a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#bind--"><code>bind()</code></a> method. Please note that the default will not be |
| used if any local address is specified.</div> |
| </li> |
| </ul> |
| <a name="setDefaultLocalAddresses-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDefaultLocalAddresses</h4> |
| <pre>void setDefaultLocalAddresses(java.util.List<? extends java.net.SocketAddress> localAddresses)</pre> |
| <div class="block">Sets the default local addresses to bind when no argument is specified |
| in <a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#bind--"><code>bind()</code></a> method. Please note that the default will not be |
| used if any local address is specified.</div> |
| </li> |
| </ul> |
| <a name="isCloseOnDeactivation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCloseOnDeactivation</h4> |
| <pre>boolean isCloseOnDeactivation()</pre> |
| <div class="block">Returns <tt>true</tt> if and only if all clients are closed when this |
| acceptor unbinds from all the related local address (i.e. when the |
| service is deactivated).</div> |
| </li> |
| </ul> |
| <a name="setCloseOnDeactivation-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCloseOnDeactivation</h4> |
| <pre>void setCloseOnDeactivation(boolean closeOnDeactivation)</pre> |
| <div class="block">Sets whether all client sessions are closed when this acceptor unbinds |
| from all the related local addresses (i.e. when the service is |
| deactivated). The default value is <tt>true</tt>.</div> |
| </li> |
| </ul> |
| <a name="bind--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bind</h4> |
| <pre>void bind() |
| throws java.io.IOException</pre> |
| <div class="block">Binds to the default local address(es) and start to accept incoming |
| connections.</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-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bind</h4> |
| <pre>void bind(java.net.SocketAddress localAddress) |
| throws java.io.IOException</pre> |
| <div class="block">Binds to the specified local address and start to accept incoming |
| connections.</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-java.net.SocketAddress...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bind</h4> |
| <pre>void bind(java.net.SocketAddress firstLocalAddress, |
| java.net.SocketAddress... otherLocalAddresses) |
| throws java.io.IOException</pre> |
| <div class="block">Binds to the specified local addresses and start to accept incoming |
| connections.</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.lang.Iterable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bind</h4> |
| <pre>void bind(java.lang.Iterable<? extends java.net.SocketAddress> localAddresses) |
| throws java.io.IOException</pre> |
| <div class="block">Binds to the specified local addresses and start to accept incoming |
| connections.</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="unbind--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unbind</h4> |
| <pre>void unbind()</pre> |
| <div class="block">Unbinds from all local addresses that this service is bound to and stops |
| to accept incoming connections. All managed connections will be closed |
| if <a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#setCloseOnDeactivation-boolean-"><code>disconnectOnUnbind</code></a> property |
| is <tt>true</tt>. This method returns silently if no local address is |
| bound yet.</div> |
| </li> |
| </ul> |
| <a name="unbind-java.net.SocketAddress-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unbind</h4> |
| <pre>void unbind(java.net.SocketAddress localAddress)</pre> |
| <div class="block">Unbinds from the specified local address and stop to accept incoming |
| connections. All managed connections will be closed if |
| <a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#setCloseOnDeactivation-boolean-"><code>disconnectOnUnbind</code></a> property is |
| <tt>true</tt>. This method returns silently if the default local |
| address is not bound yet.</div> |
| </li> |
| </ul> |
| <a name="unbind-java.net.SocketAddress-java.net.SocketAddress...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unbind</h4> |
| <pre>void unbind(java.net.SocketAddress firstLocalAddress, |
| java.net.SocketAddress... otherLocalAddresses)</pre> |
| <div class="block">Unbinds from the specified local addresses and stop to accept incoming |
| connections. All managed connections will be closed if |
| <a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#setCloseOnDeactivation-boolean-"><code>disconnectOnUnbind</code></a> property is |
| <tt>true</tt>. This method returns silently if the default local |
| addresses are not bound yet.</div> |
| </li> |
| </ul> |
| <a name="unbind-java.lang.Iterable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unbind</h4> |
| <pre>void unbind(java.lang.Iterable<? extends java.net.SocketAddress> localAddresses)</pre> |
| <div class="block">Unbinds from the specified local addresses and stop to accept incoming |
| connections. All managed connections will be closed if |
| <a href="../../../../../org/apache/mina/core/service/IoAcceptor.html#setCloseOnDeactivation-boolean-"><code>disconnectOnUnbind</code></a> property is |
| <tt>true</tt>. This method returns silently if the default local |
| addresses are not bound yet.</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/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</a> newSession(java.net.SocketAddress remoteAddress, |
| java.net.SocketAddress localAddress)</pre> |
| <div class="block">(Optional) Returns an <a href="../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a> that is bound to the specified |
| <tt>localAddress</tt> and the specified <tt>remoteAddress</tt> which |
| reuses the local address that is already bound by this service. |
| <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.IllegalStateException</code> - if this service is not running.</dd> |
| <dd><code>java.lang.IllegalArgumentException</code> - if this service is not bound to the |
| specified <tt>localAddress</tt>.</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/core/service/DefaultTransportMetadata.html" title="class in org.apache.mina.core.service"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/mina/core/service/IoConnector.html" title="interface in org.apache.mina.core.service"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/mina/core/service/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.apache.org/">Apache MINA Project</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
