| <!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 18:07:14 CET 2019 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>IoService (Apache MINA 2.0.0-M1 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="IoService (Apache MINA 2.0.0-M1 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,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6,"i46":6,"i47":6,"i48":6,"i49":6,"i50":6,"i51":6,"i52":6,"i53":6,"i54":6,"i55":6,"i56":6,"i57":6,"i58":6,"i59":6,"i60":6,"i61":6,"i62":6,"i63":6,"i64":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/IoService.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/IoProcessor.html" title="interface in org.apache.mina.common"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/mina/common/IoServiceListener.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/IoService.html" target="_top">Frames</a></li> |
| <li><a href="IoService.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 IoService" class="title">Interface IoService</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/DatagramAcceptor.html" title="interface in org.apache.mina.transport.socket">DatagramAcceptor</a>, <a href="../../../../org/apache/mina/transport/socket/DatagramConnector.html" title="interface in org.apache.mina.transport.socket">DatagramConnector</a>, <a href="../../../../org/apache/mina/transport/socket/DatagramService.html" title="interface in org.apache.mina.transport.socket">DatagramService</a>, <a href="../../../../org/apache/mina/common/IoAcceptor.html" title="interface in org.apache.mina.common">IoAcceptor</a>, <a href="../../../../org/apache/mina/common/IoConnector.html" title="interface in org.apache.mina.common">IoConnector</a>, <a href="../../../../org/apache/mina/transport/socket/SocketAcceptor.html" title="interface in org.apache.mina.transport.socket">SocketAcceptor</a>, <a href="../../../../org/apache/mina/transport/socket/SocketConnector.html" title="interface in org.apache.mina.transport.socket">SocketConnector</a>, <a href="../../../../org/apache/mina/transport/socket/SocketService.html" title="interface in org.apache.mina.transport.socket">SocketService</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/mina/common/AbstractIoAcceptor.html" title="class in org.apache.mina.common">AbstractIoAcceptor</a>, <a href="../../../../org/apache/mina/common/AbstractIoConnector.html" title="class in org.apache.mina.common">AbstractIoConnector</a>, <a href="../../../../org/apache/mina/common/AbstractIoService.html" title="class in org.apache.mina.common">AbstractIoService</a>, <a href="../../../../org/apache/mina/common/AbstractPollingConnectionlessIoAcceptor.html" title="class in org.apache.mina.common">AbstractPollingConnectionlessIoAcceptor</a>, <a href="../../../../org/apache/mina/common/AbstractPollingIoAcceptor.html" title="class in org.apache.mina.common">AbstractPollingIoAcceptor</a>, <a href="../../../../org/apache/mina/common/AbstractPollingIoConnector.html" title="class in org.apache.mina.common">AbstractPollingIoConnector</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/apr/AprSocketConnector.html" title="class in org.apache.mina.transport.socket.apr">AprSocketConnector</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/NioDatagramConnector.html" title="class in org.apache.mina.transport.socket.nio">NioDatagramConnector</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/socket/nio/NioSocketConnector.html" title="class in org.apache.mina.transport.socket.nio">NioSocketConnector</a>, <a href="../../../../org/apache/mina/transport/vmpipe/VmPipeAcceptor.html" title="class in org.apache.mina.transport.vmpipe">VmPipeAcceptor</a>, <a href="../../../../org/apache/mina/transport/vmpipe/VmPipeConnector.html" title="class in org.apache.mina.transport.vmpipe">VmPipeConnector</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">IoService</span></pre> |
| <div class="block">Base interface for all <a href="../../../../org/apache/mina/common/IoAcceptor.html" title="interface in org.apache.mina.common"><code>IoAcceptor</code></a>s and <a href="../../../../org/apache/mina/common/IoConnector.html" title="interface in org.apache.mina.common"><code>IoConnector</code></a>s |
| that provide I/O service and manage <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="simpleTagLabel">Version:</span></dt> |
| <dd>$Rev: 606098 $, $Date: 2007-12-21 06:11:58 +0100 (Fri, 21 Dec 2007) $</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/common/IoService.html#addListener-org.apache.mina.common.IoServiceListener-">addListener</a></span>(<a href="../../../../org/apache/mina/common/IoServiceListener.html" title="interface in org.apache.mina.common">IoServiceListener</a> listener)</code> |
| <div class="block">Adds an <a href="../../../../org/apache/mina/common/IoServiceListener.html" title="interface in org.apache.mina.common"><code>IoServiceListener</code></a> that listens any events related with |
| this service.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.util.Set<<a href="../../../../org/apache/mina/common/WriteFuture.html" title="interface in org.apache.mina.common">WriteFuture</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#broadcast-java.lang.Object-">broadcast</a></span>(java.lang.Object message)</code> |
| <div class="block">Writes the specified <code>message</code> to all the <a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><code>IoSession</code></a>s |
| managed by this service.</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/common/IoService.html#dispose--">dispose</a></span>()</code> |
| <div class="block">Releases any resources allocated by this service.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getActivationTime--">getActivationTime</a></span>()</code> |
| <div class="block">Returns the time when this service was activated.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getBothIdleCount--">getBothIdleCount</a></span>()</code> |
| <div class="block">Returns the number of the fired continuous <tt>serviceIdle</tt> events |
| for <a href="../../../../org/apache/mina/common/IdleStatus.html#BOTH_IDLE"><code>IdleStatus.BOTH_IDLE</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getBothIdleTime--">getBothIdleTime</a></span>()</code> |
| <div class="block">Returns idle time for <a href="../../../../org/apache/mina/common/IdleStatus.html#BOTH_IDLE"><code>IdleStatus.BOTH_IDLE</code></a> in seconds.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getBothIdleTimeInMillis--">getBothIdleTimeInMillis</a></span>()</code> |
| <div class="block">Returns idle time for <a href="../../../../org/apache/mina/common/IdleStatus.html#BOTH_IDLE"><code>IdleStatus.BOTH_IDLE</code></a> in milliseconds.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getCumulativeManagedSessionCount--">getCumulativeManagedSessionCount</a></span>()</code> |
| <div class="block">Returns the cumulative number of sessions which were managed (or are |
| being managed) by this service, which means 'currently managed session |
| count + closed session count'.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <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/IoService.html#getFilterChain--">getFilterChain</a></span>()</code> |
| <div class="block">A shortcut for <tt>( ( DefaultIoFilterChainBuilder ) </tt><a href="../../../../org/apache/mina/common/IoService.html#getFilterChainBuilder--"><code>getFilterChainBuilder()</code></a><tt> )</tt>.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <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/IoService.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 build 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 |
| by this service.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/mina/common/IoHandler.html" title="interface in org.apache.mina.common">IoHandler</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getHandler--">getHandler</a></span>()</code> |
| <div class="block">Returns the handler which will handle all connections managed by this service.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getIdleCount-org.apache.mina.common.IdleStatus-">getIdleCount</a></span>(<a href="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</a> status)</code> |
| <div class="block">Returns the number of the fired continuous <tt>serviceIdle</tt> events |
| for the specified <a href="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common"><code>IdleStatus</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getIdleTime-org.apache.mina.common.IdleStatus-">getIdleTime</a></span>(<a href="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</a> status)</code> |
| <div class="block">Returns idle time for the specified type of idleness in seconds.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getIdleTimeInMillis-org.apache.mina.common.IdleStatus-">getIdleTimeInMillis</a></span>(<a href="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</a> status)</code> |
| <div class="block">Returns idle time for the specified type of idleness in milliseconds.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getLargestManagedSessionCount--">getLargestManagedSessionCount</a></span>()</code> |
| <div class="block">Returns the maximum number of sessions which were being managed at the |
| same time.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getLargestReadBytesThroughput--">getLargestReadBytesThroughput</a></span>()</code> |
| <div class="block">Returns the maximum of the <a href="../../../../org/apache/mina/common/IoService.html#getReadBytesThroughput--"><code>readBytesThroughput</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getLargestReadMessagesThroughput--">getLargestReadMessagesThroughput</a></span>()</code> |
| <div class="block">Returns the maximum of the <a href="../../../../org/apache/mina/common/IoService.html#getReadMessagesThroughput--"><code>readMessagesThroughput</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getLargestWrittenBytesThroughput--">getLargestWrittenBytesThroughput</a></span>()</code> |
| <div class="block">Returns the maximum of the <a href="../../../../org/apache/mina/common/IoService.html#getWrittenBytesThroughput--"><code>writtenBytesThroughput</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getLargestWrittenMessagesThroughput--">getLargestWrittenMessagesThroughput</a></span>()</code> |
| <div class="block">Returns the maximum of the <a href="../../../../org/apache/mina/common/IoService.html#getWrittenMessagesThroughput--"><code>writtenMessagesThroughput</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getLastBothIdleTime--">getLastBothIdleTime</a></span>()</code> |
| <div class="block">Returns the time in milliseconds when the last <tt>serviceIdle</tt> event |
| is fired for <a href="../../../../org/apache/mina/common/IdleStatus.html#BOTH_IDLE"><code>IdleStatus.BOTH_IDLE</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getLastIdleTime-org.apache.mina.common.IdleStatus-">getLastIdleTime</a></span>(<a href="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</a> status)</code> |
| <div class="block">Returns the time in milliseconds when the last <tt>serviceIdle</tt> event |
| is fired for the specified <a href="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common"><code>IdleStatus</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getLastIoTime--">getLastIoTime</a></span>()</code> |
| <div class="block">Returns the time in millis when I/O occurred lastly.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getLastReaderIdleTime--">getLastReaderIdleTime</a></span>()</code> |
| <div class="block">Returns the time in milliseconds when the last <tt>serviceIdle</tt> event |
| is fired for <a href="../../../../org/apache/mina/common/IdleStatus.html#READER_IDLE"><code>IdleStatus.READER_IDLE</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getLastReadTime--">getLastReadTime</a></span>()</code> |
| <div class="block">Returns the time in millis when read operation occurred lastly.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getLastWriterIdleTime--">getLastWriterIdleTime</a></span>()</code> |
| <div class="block">Returns the time in milliseconds when the last <tt>serviceIdle</tt> event |
| is fired for <a href="../../../../org/apache/mina/common/IdleStatus.html#WRITER_IDLE"><code>IdleStatus.WRITER_IDLE</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getLastWriteTime--">getLastWriteTime</a></span>()</code> |
| <div class="block">Returns the time in millis when write operation occurred lastly.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getManagedSessionCount--">getManagedSessionCount</a></span>()</code> |
| <div class="block">Returns the number of all sessions which are currently managed by this |
| service.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>java.util.Set<<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/IoService.html#getManagedSessions--">getManagedSessions</a></span>()</code> |
| <div class="block">Returns all sessions which are currently managed by this service.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getReadBytes--">getReadBytes</a></span>()</code> |
| <div class="block">Returns the number of bytes read by this service</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getReadBytesThroughput--">getReadBytesThroughput</a></span>()</code> |
| <div class="block">Returns the number of read bytes per second.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getReaderIdleCount--">getReaderIdleCount</a></span>()</code> |
| <div class="block">Returns the number of the fired continuous <tt>serviceIdle</tt> events |
| for <a href="../../../../org/apache/mina/common/IdleStatus.html#READER_IDLE"><code>IdleStatus.READER_IDLE</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getReaderIdleTime--">getReaderIdleTime</a></span>()</code> |
| <div class="block">Returns idle time for <a href="../../../../org/apache/mina/common/IdleStatus.html#READER_IDLE"><code>IdleStatus.READER_IDLE</code></a> in seconds.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getReaderIdleTimeInMillis--">getReaderIdleTimeInMillis</a></span>()</code> |
| <div class="block">Returns idle time for <a href="../../../../org/apache/mina/common/IdleStatus.html#READER_IDLE"><code>IdleStatus.READER_IDLE</code></a> in milliseconds.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getReadMessages--">getReadMessages</a></span>()</code> |
| <div class="block">Returns the number of messages this services has read</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getReadMessagesThroughput--">getReadMessagesThroughput</a></span>()</code> |
| <div class="block">Returns the number of read messages per second.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getScheduledWriteBytes--">getScheduledWriteBytes</a></span>()</code> |
| <div class="block">Returns the number of bytes scheduled to be written</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getScheduledWriteMessages--">getScheduledWriteMessages</a></span>()</code> |
| <div class="block">Returns the number of messages scheduled to be written</div> |
| </td> |
| </tr> |
| <tr id="i37" 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/IoService.html#getSessionConfig--">getSessionConfig</a></span>()</code> |
| <div class="block">Returns 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 |
| created by this service.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/mina/common/IoSessionDataStructureFactory.html" title="interface in org.apache.mina.common">IoSessionDataStructureFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getSessionDataStructureFactory--">getSessionDataStructureFactory</a></span>()</code> |
| <div class="block">Returns the <a href="../../../../org/apache/mina/common/IoSessionDataStructureFactory.html" title="interface in org.apache.mina.common"><code>IoSessionDataStructureFactory</code></a> that provides |
| related data structures for a new session created by this service.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getThroughputCalculationInterval--">getThroughputCalculationInterval</a></span>()</code> |
| <div class="block">Returns the interval (seconds) between each throughput calculation.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getThroughputCalculationIntervalInMillis--">getThroughputCalculationIntervalInMillis</a></span>()</code> |
| <div class="block">Returns the interval (milliseconds) between each throughput calculation.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/mina/common/TransportMetadata.html" title="interface in org.apache.mina.common">TransportMetadata</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getTransportMetadata--">getTransportMetadata</a></span>()</code> |
| <div class="block">Returns the <a href="../../../../org/apache/mina/common/TransportMetadata.html" title="interface in org.apache.mina.common"><code>TransportMetadata</code></a> that this service runs on.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getWriterIdleCount--">getWriterIdleCount</a></span>()</code> |
| <div class="block">Returns the number of the fired continuous <tt>serviceIdle</tt> events |
| for <a href="../../../../org/apache/mina/common/IdleStatus.html#WRITER_IDLE"><code>IdleStatus.WRITER_IDLE</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getWriterIdleTime--">getWriterIdleTime</a></span>()</code> |
| <div class="block">Returns idle time for <a href="../../../../org/apache/mina/common/IdleStatus.html#WRITER_IDLE"><code>IdleStatus.WRITER_IDLE</code></a> in seconds.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getWriterIdleTimeInMillis--">getWriterIdleTimeInMillis</a></span>()</code> |
| <div class="block">Returns idle time for <a href="../../../../org/apache/mina/common/IdleStatus.html#WRITER_IDLE"><code>IdleStatus.WRITER_IDLE</code></a> in milliseconds.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getWrittenBytes--">getWrittenBytes</a></span>()</code> |
| <div class="block">Returns the number of bytes written out by this service</div> |
| </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getWrittenBytesThroughput--">getWrittenBytesThroughput</a></span>()</code> |
| <div class="block">Returns the number of written bytes per second.</div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getWrittenMessages--">getWrittenMessages</a></span>()</code> |
| <div class="block">Returns the number of messages this service has written</div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#getWrittenMessagesThroughput--">getWrittenMessagesThroughput</a></span>()</code> |
| <div class="block">Returns the number of written messages per second.</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#isActive--">isActive</a></span>()</code> |
| <div class="block">Returns a value of whether or not this service is active</div> |
| </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#isBothIdle--">isBothIdle</a></span>()</code> |
| <div class="block">Returns <code>true</code> if this service is <a href="../../../../org/apache/mina/common/IdleStatus.html#BOTH_IDLE"><code>IdleStatus.BOTH_IDLE</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#isDisposed--">isDisposed</a></span>()</code> |
| <div class="block">Returns <tt>true</tt> if and if only all resources of this processor |
| have been disposed.</div> |
| </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#isDisposing--">isDisposing</a></span>()</code> |
| <div class="block">Returns <tt>true</tt> if and if only <a href="../../../../org/apache/mina/common/IoService.html#dispose--"><code>dispose()</code></a> method has |
| been called.</div> |
| </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#isIdle-org.apache.mina.common.IdleStatus-">isIdle</a></span>(<a href="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</a> status)</code> |
| <div class="block">Returns <code>true</code> if this service is idle for the specified |
| <a href="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common"><code>IdleStatus</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#isReaderIdle--">isReaderIdle</a></span>()</code> |
| <div class="block">Returns <code>true</code> if this service is <a href="../../../../org/apache/mina/common/IdleStatus.html#READER_IDLE"><code>IdleStatus.READER_IDLE</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#isWriterIdle--">isWriterIdle</a></span>()</code> |
| <div class="block">Returns <code>true</code> if this service is <a href="../../../../org/apache/mina/common/IdleStatus.html#WRITER_IDLE"><code>IdleStatus.WRITER_IDLE</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i56" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#removeListener-org.apache.mina.common.IoServiceListener-">removeListener</a></span>(<a href="../../../../org/apache/mina/common/IoServiceListener.html" title="interface in org.apache.mina.common">IoServiceListener</a> listener)</code> |
| <div class="block">Removed an existing <a href="../../../../org/apache/mina/common/IoServiceListener.html" title="interface in org.apache.mina.common"><code>IoServiceListener</code></a> that listens any events |
| related with this service.</div> |
| </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#setBothIdleTime-int-">setBothIdleTime</a></span>(int idleTime)</code> |
| <div class="block">Sets idle time for <a href="../../../../org/apache/mina/common/IdleStatus.html#WRITER_IDLE"><code>IdleStatus.WRITER_IDLE</code></a> in seconds.</div> |
| </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.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> 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 build 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 |
| by this service.</div> |
| </td> |
| </tr> |
| <tr id="i59" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#setHandler-org.apache.mina.common.IoHandler-">setHandler</a></span>(<a href="../../../../org/apache/mina/common/IoHandler.html" title="interface in org.apache.mina.common">IoHandler</a> handler)</code> |
| <div class="block">Sets the handler which will handle all connections managed by this service.</div> |
| </td> |
| </tr> |
| <tr id="i60" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#setIdleTime-org.apache.mina.common.IdleStatus-int-">setIdleTime</a></span>(<a href="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</a> status, |
| int idleTime)</code> |
| <div class="block">Sets idle time for the specified type of idleness in seconds.</div> |
| </td> |
| </tr> |
| <tr id="i61" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#setReaderIdleTime-int-">setReaderIdleTime</a></span>(int idleTime)</code> |
| <div class="block">Sets idle time for <a href="../../../../org/apache/mina/common/IdleStatus.html#READER_IDLE"><code>IdleStatus.READER_IDLE</code></a> in seconds.</div> |
| </td> |
| </tr> |
| <tr id="i62" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#setSessionDataStructureFactory-org.apache.mina.common.IoSessionDataStructureFactory-">setSessionDataStructureFactory</a></span>(<a href="../../../../org/apache/mina/common/IoSessionDataStructureFactory.html" title="interface in org.apache.mina.common">IoSessionDataStructureFactory</a> sessionDataStructureFactory)</code> |
| <div class="block">Sets the <a href="../../../../org/apache/mina/common/IoSessionDataStructureFactory.html" title="interface in org.apache.mina.common"><code>IoSessionDataStructureFactory</code></a> that provides |
| related data structures for a new session created by this service.</div> |
| </td> |
| </tr> |
| <tr id="i63" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#setThroughputCalculationInterval-int-">setThroughputCalculationInterval</a></span>(int throughputCalculationInterval)</code> |
| <div class="block">Sets the interval (seconds) between each throughput calculation.</div> |
| </td> |
| </tr> |
| <tr id="i64" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoService.html#setWriterIdleTime-int-">setWriterIdleTime</a></span>(int idleTime)</code> |
| <div class="block">Sets idle time for <a href="../../../../org/apache/mina/common/IdleStatus.html#WRITER_IDLE"><code>IdleStatus.WRITER_IDLE</code></a> in seconds.</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="getTransportMetadata--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTransportMetadata</h4> |
| <pre><a href="../../../../org/apache/mina/common/TransportMetadata.html" title="interface in org.apache.mina.common">TransportMetadata</a> getTransportMetadata()</pre> |
| <div class="block">Returns the <a href="../../../../org/apache/mina/common/TransportMetadata.html" title="interface in org.apache.mina.common"><code>TransportMetadata</code></a> that this service runs on.</div> |
| </li> |
| </ul> |
| <a name="addListener-org.apache.mina.common.IoServiceListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addListener</h4> |
| <pre>void addListener(<a href="../../../../org/apache/mina/common/IoServiceListener.html" title="interface in org.apache.mina.common">IoServiceListener</a> listener)</pre> |
| <div class="block">Adds an <a href="../../../../org/apache/mina/common/IoServiceListener.html" title="interface in org.apache.mina.common"><code>IoServiceListener</code></a> that listens any events related with |
| this service.</div> |
| </li> |
| </ul> |
| <a name="removeListener-org.apache.mina.common.IoServiceListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeListener</h4> |
| <pre>void removeListener(<a href="../../../../org/apache/mina/common/IoServiceListener.html" title="interface in org.apache.mina.common">IoServiceListener</a> listener)</pre> |
| <div class="block">Removed an existing <a href="../../../../org/apache/mina/common/IoServiceListener.html" title="interface in org.apache.mina.common"><code>IoServiceListener</code></a> that listens any events |
| related with this service.</div> |
| </li> |
| </ul> |
| <a name="isDisposing--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDisposing</h4> |
| <pre>boolean isDisposing()</pre> |
| <div class="block">Returns <tt>true</tt> if and if only <a href="../../../../org/apache/mina/common/IoService.html#dispose--"><code>dispose()</code></a> method has |
| been called. Please note that this method will return <tt>true</tt> |
| even after all the related resources are released.</div> |
| </li> |
| </ul> |
| <a name="isDisposed--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDisposed</h4> |
| <pre>boolean isDisposed()</pre> |
| <div class="block">Returns <tt>true</tt> if and if only all resources of this processor |
| have been disposed.</div> |
| </li> |
| </ul> |
| <a name="dispose--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dispose</h4> |
| <pre>void dispose()</pre> |
| <div class="block">Releases any resources allocated by this service. Please note that |
| this method might block as long as there are any sessions managed by |
| this service.</div> |
| </li> |
| </ul> |
| <a name="getHandler--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHandler</h4> |
| <pre><a href="../../../../org/apache/mina/common/IoHandler.html" title="interface in org.apache.mina.common">IoHandler</a> getHandler()</pre> |
| <div class="block">Returns the handler which will handle all connections managed by this service.</div> |
| </li> |
| </ul> |
| <a name="setHandler-org.apache.mina.common.IoHandler-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHandler</h4> |
| <pre>void setHandler(<a href="../../../../org/apache/mina/common/IoHandler.html" title="interface in org.apache.mina.common">IoHandler</a> handler)</pre> |
| <div class="block">Sets the handler which will handle all connections managed by this service.</div> |
| </li> |
| </ul> |
| <a name="getManagedSessions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getManagedSessions</h4> |
| <pre>java.util.Set<<a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</a>> getManagedSessions()</pre> |
| <div class="block">Returns all sessions which are currently managed by this service.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the sessions. An empty collection if there's no session.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getManagedSessionCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getManagedSessionCount</h4> |
| <pre>int getManagedSessionCount()</pre> |
| <div class="block">Returns the number of all sessions which are currently managed by this |
| service.</div> |
| </li> |
| </ul> |
| <a name="getLargestManagedSessionCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLargestManagedSessionCount</h4> |
| <pre>int getLargestManagedSessionCount()</pre> |
| <div class="block">Returns the maximum number of sessions which were being managed at the |
| same time.</div> |
| </li> |
| </ul> |
| <a name="getCumulativeManagedSessionCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCumulativeManagedSessionCount</h4> |
| <pre>long getCumulativeManagedSessionCount()</pre> |
| <div class="block">Returns the cumulative number of sessions which were managed (or are |
| being managed) by this service, which means 'currently managed session |
| count + closed session count'.</div> |
| </li> |
| </ul> |
| <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> getSessionConfig()</pre> |
| <div class="block">Returns 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 |
| created by this service.</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> 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 build 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 |
| by this service. |
| 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 setFilterChainBuilder(<a href="../../../../org/apache/mina/common/IoFilterChainBuilder.html" title="interface in org.apache.mina.common">IoFilterChainBuilder</a> 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 build 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 |
| by this service. |
| 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> getFilterChain()</pre> |
| <div class="block">A shortcut for <tt>( ( DefaultIoFilterChainBuilder ) </tt><a href="../../../../org/apache/mina/common/IoService.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="isActive--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isActive</h4> |
| <pre>boolean isActive()</pre> |
| <div class="block">Returns a value of whether or not this service is active</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether of not the service is active.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getActivationTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getActivationTime</h4> |
| <pre>long getActivationTime()</pre> |
| <div class="block">Returns the time when this service was activated. It returns the last |
| time when this service was activated if the service is not active now.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The time by using <code>System.currentTimeMillis()</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLastIoTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLastIoTime</h4> |
| <pre>long getLastIoTime()</pre> |
| <div class="block">Returns the time in millis when I/O occurred lastly.</div> |
| </li> |
| </ul> |
| <a name="getLastReadTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLastReadTime</h4> |
| <pre>long getLastReadTime()</pre> |
| <div class="block">Returns the time in millis when read operation occurred lastly.</div> |
| </li> |
| </ul> |
| <a name="getLastWriteTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLastWriteTime</h4> |
| <pre>long getLastWriteTime()</pre> |
| <div class="block">Returns the time in millis when write operation occurred lastly.</div> |
| </li> |
| </ul> |
| <a name="isIdle-org.apache.mina.common.IdleStatus-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isIdle</h4> |
| <pre>boolean isIdle(<a href="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</a> status)</pre> |
| <div class="block">Returns <code>true</code> if this service is idle for the specified |
| <a href="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common"><code>IdleStatus</code></a>.</div> |
| </li> |
| </ul> |
| <a name="isReaderIdle--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isReaderIdle</h4> |
| <pre>boolean isReaderIdle()</pre> |
| <div class="block">Returns <code>true</code> if this service is <a href="../../../../org/apache/mina/common/IdleStatus.html#READER_IDLE"><code>IdleStatus.READER_IDLE</code></a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/mina/common/IoService.html#isIdle-org.apache.mina.common.IdleStatus-"><code>isIdle(IdleStatus)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isWriterIdle--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isWriterIdle</h4> |
| <pre>boolean isWriterIdle()</pre> |
| <div class="block">Returns <code>true</code> if this service is <a href="../../../../org/apache/mina/common/IdleStatus.html#WRITER_IDLE"><code>IdleStatus.WRITER_IDLE</code></a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/mina/common/IoService.html#isIdle-org.apache.mina.common.IdleStatus-"><code>isIdle(IdleStatus)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isBothIdle--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isBothIdle</h4> |
| <pre>boolean isBothIdle()</pre> |
| <div class="block">Returns <code>true</code> if this service is <a href="../../../../org/apache/mina/common/IdleStatus.html#BOTH_IDLE"><code>IdleStatus.BOTH_IDLE</code></a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/mina/common/IoService.html#isIdle-org.apache.mina.common.IdleStatus-"><code>isIdle(IdleStatus)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIdleCount-org.apache.mina.common.IdleStatus-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIdleCount</h4> |
| <pre>int getIdleCount(<a href="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</a> status)</pre> |
| <div class="block">Returns the number of the fired continuous <tt>serviceIdle</tt> events |
| for the specified <a href="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common"><code>IdleStatus</code></a>. |
| <p/> |
| If <tt>serviceIdle</tt> event is fired first after some time after I/O, |
| <tt>idleCount</tt> becomes <tt>1</tt>. <tt>idleCount</tt> resets to |
| <tt>0</tt> if any I/O occurs again, otherwise it increases to |
| <tt>2</tt> and so on if <tt>serviceIdle</tt> event is fired again without |
| any I/O between two (or more) <tt>serviceIdle</tt> events.</div> |
| </li> |
| </ul> |
| <a name="getReaderIdleCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReaderIdleCount</h4> |
| <pre>int getReaderIdleCount()</pre> |
| <div class="block">Returns the number of the fired continuous <tt>serviceIdle</tt> events |
| for <a href="../../../../org/apache/mina/common/IdleStatus.html#READER_IDLE"><code>IdleStatus.READER_IDLE</code></a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/mina/common/IoService.html#getIdleCount-org.apache.mina.common.IdleStatus-"><code>getIdleCount(IdleStatus)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getWriterIdleCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWriterIdleCount</h4> |
| <pre>int getWriterIdleCount()</pre> |
| <div class="block">Returns the number of the fired continuous <tt>serviceIdle</tt> events |
| for <a href="../../../../org/apache/mina/common/IdleStatus.html#WRITER_IDLE"><code>IdleStatus.WRITER_IDLE</code></a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/mina/common/IoService.html#getIdleCount-org.apache.mina.common.IdleStatus-"><code>getIdleCount(IdleStatus)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBothIdleCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBothIdleCount</h4> |
| <pre>int getBothIdleCount()</pre> |
| <div class="block">Returns the number of the fired continuous <tt>serviceIdle</tt> events |
| for <a href="../../../../org/apache/mina/common/IdleStatus.html#BOTH_IDLE"><code>IdleStatus.BOTH_IDLE</code></a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/mina/common/IoService.html#getIdleCount-org.apache.mina.common.IdleStatus-"><code>getIdleCount(IdleStatus)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLastIdleTime-org.apache.mina.common.IdleStatus-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLastIdleTime</h4> |
| <pre>long getLastIdleTime(<a href="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</a> status)</pre> |
| <div class="block">Returns the time in milliseconds when the last <tt>serviceIdle</tt> event |
| is fired for the specified <a href="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common"><code>IdleStatus</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getLastReaderIdleTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLastReaderIdleTime</h4> |
| <pre>long getLastReaderIdleTime()</pre> |
| <div class="block">Returns the time in milliseconds when the last <tt>serviceIdle</tt> event |
| is fired for <a href="../../../../org/apache/mina/common/IdleStatus.html#READER_IDLE"><code>IdleStatus.READER_IDLE</code></a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/mina/common/IoService.html#getLastIdleTime-org.apache.mina.common.IdleStatus-"><code>getLastIdleTime(IdleStatus)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLastWriterIdleTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLastWriterIdleTime</h4> |
| <pre>long getLastWriterIdleTime()</pre> |
| <div class="block">Returns the time in milliseconds when the last <tt>serviceIdle</tt> event |
| is fired for <a href="../../../../org/apache/mina/common/IdleStatus.html#WRITER_IDLE"><code>IdleStatus.WRITER_IDLE</code></a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/mina/common/IoService.html#getLastIdleTime-org.apache.mina.common.IdleStatus-"><code>getLastIdleTime(IdleStatus)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLastBothIdleTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLastBothIdleTime</h4> |
| <pre>long getLastBothIdleTime()</pre> |
| <div class="block">Returns the time in milliseconds when the last <tt>serviceIdle</tt> event |
| is fired for <a href="../../../../org/apache/mina/common/IdleStatus.html#BOTH_IDLE"><code>IdleStatus.BOTH_IDLE</code></a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/mina/common/IoService.html#getLastIdleTime-org.apache.mina.common.IdleStatus-"><code>getLastIdleTime(IdleStatus)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIdleTime-org.apache.mina.common.IdleStatus-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIdleTime</h4> |
| <pre>int getIdleTime(<a href="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</a> status)</pre> |
| <div class="block">Returns idle time for the specified type of idleness in seconds.</div> |
| </li> |
| </ul> |
| <a name="getIdleTimeInMillis-org.apache.mina.common.IdleStatus-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIdleTimeInMillis</h4> |
| <pre>long getIdleTimeInMillis(<a href="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</a> status)</pre> |
| <div class="block">Returns idle time for the specified type of idleness in milliseconds.</div> |
| </li> |
| </ul> |
| <a name="setIdleTime-org.apache.mina.common.IdleStatus-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIdleTime</h4> |
| <pre>void setIdleTime(<a href="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</a> status, |
| int idleTime)</pre> |
| <div class="block">Sets idle time for the specified type of idleness in seconds.</div> |
| </li> |
| </ul> |
| <a name="getReaderIdleTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReaderIdleTime</h4> |
| <pre>int getReaderIdleTime()</pre> |
| <div class="block">Returns idle time for <a href="../../../../org/apache/mina/common/IdleStatus.html#READER_IDLE"><code>IdleStatus.READER_IDLE</code></a> in seconds.</div> |
| </li> |
| </ul> |
| <a name="getReaderIdleTimeInMillis--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReaderIdleTimeInMillis</h4> |
| <pre>long getReaderIdleTimeInMillis()</pre> |
| <div class="block">Returns idle time for <a href="../../../../org/apache/mina/common/IdleStatus.html#READER_IDLE"><code>IdleStatus.READER_IDLE</code></a> in milliseconds.</div> |
| </li> |
| </ul> |
| <a name="setReaderIdleTime-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReaderIdleTime</h4> |
| <pre>void setReaderIdleTime(int idleTime)</pre> |
| <div class="block">Sets idle time for <a href="../../../../org/apache/mina/common/IdleStatus.html#READER_IDLE"><code>IdleStatus.READER_IDLE</code></a> in seconds.</div> |
| </li> |
| </ul> |
| <a name="getWriterIdleTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWriterIdleTime</h4> |
| <pre>int getWriterIdleTime()</pre> |
| <div class="block">Returns idle time for <a href="../../../../org/apache/mina/common/IdleStatus.html#WRITER_IDLE"><code>IdleStatus.WRITER_IDLE</code></a> in seconds.</div> |
| </li> |
| </ul> |
| <a name="getWriterIdleTimeInMillis--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWriterIdleTimeInMillis</h4> |
| <pre>long getWriterIdleTimeInMillis()</pre> |
| <div class="block">Returns idle time for <a href="../../../../org/apache/mina/common/IdleStatus.html#WRITER_IDLE"><code>IdleStatus.WRITER_IDLE</code></a> in milliseconds.</div> |
| </li> |
| </ul> |
| <a name="setWriterIdleTime-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setWriterIdleTime</h4> |
| <pre>void setWriterIdleTime(int idleTime)</pre> |
| <div class="block">Sets idle time for <a href="../../../../org/apache/mina/common/IdleStatus.html#WRITER_IDLE"><code>IdleStatus.WRITER_IDLE</code></a> in seconds.</div> |
| </li> |
| </ul> |
| <a name="getBothIdleTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBothIdleTime</h4> |
| <pre>int getBothIdleTime()</pre> |
| <div class="block">Returns idle time for <a href="../../../../org/apache/mina/common/IdleStatus.html#BOTH_IDLE"><code>IdleStatus.BOTH_IDLE</code></a> in seconds.</div> |
| </li> |
| </ul> |
| <a name="getBothIdleTimeInMillis--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBothIdleTimeInMillis</h4> |
| <pre>long getBothIdleTimeInMillis()</pre> |
| <div class="block">Returns idle time for <a href="../../../../org/apache/mina/common/IdleStatus.html#BOTH_IDLE"><code>IdleStatus.BOTH_IDLE</code></a> in milliseconds.</div> |
| </li> |
| </ul> |
| <a name="setBothIdleTime-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBothIdleTime</h4> |
| <pre>void setBothIdleTime(int idleTime)</pre> |
| <div class="block">Sets idle time for <a href="../../../../org/apache/mina/common/IdleStatus.html#WRITER_IDLE"><code>IdleStatus.WRITER_IDLE</code></a> in seconds.</div> |
| </li> |
| </ul> |
| <a name="getReadBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReadBytes</h4> |
| <pre>long getReadBytes()</pre> |
| <div class="block">Returns the number of bytes read by this service</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The number of bytes this service has read</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getWrittenBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWrittenBytes</h4> |
| <pre>long getWrittenBytes()</pre> |
| <div class="block">Returns the number of bytes written out by this service</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The number of bytes this service has written</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getReadMessages--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReadMessages</h4> |
| <pre>long getReadMessages()</pre> |
| <div class="block">Returns the number of messages this services has read</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The number of messages this services has read</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getWrittenMessages--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWrittenMessages</h4> |
| <pre>long getWrittenMessages()</pre> |
| <div class="block">Returns the number of messages this service has written</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The number of messages this service has written</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getReadBytesThroughput--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReadBytesThroughput</h4> |
| <pre>double getReadBytesThroughput()</pre> |
| <div class="block">Returns the number of read bytes per second.</div> |
| </li> |
| </ul> |
| <a name="getWrittenBytesThroughput--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWrittenBytesThroughput</h4> |
| <pre>double getWrittenBytesThroughput()</pre> |
| <div class="block">Returns the number of written bytes per second.</div> |
| </li> |
| </ul> |
| <a name="getReadMessagesThroughput--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReadMessagesThroughput</h4> |
| <pre>double getReadMessagesThroughput()</pre> |
| <div class="block">Returns the number of read messages per second.</div> |
| </li> |
| </ul> |
| <a name="getWrittenMessagesThroughput--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWrittenMessagesThroughput</h4> |
| <pre>double getWrittenMessagesThroughput()</pre> |
| <div class="block">Returns the number of written messages per second.</div> |
| </li> |
| </ul> |
| <a name="getLargestReadBytesThroughput--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLargestReadBytesThroughput</h4> |
| <pre>double getLargestReadBytesThroughput()</pre> |
| <div class="block">Returns the maximum of the <a href="../../../../org/apache/mina/common/IoService.html#getReadBytesThroughput--"><code>readBytesThroughput</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getLargestWrittenBytesThroughput--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLargestWrittenBytesThroughput</h4> |
| <pre>double getLargestWrittenBytesThroughput()</pre> |
| <div class="block">Returns the maximum of the <a href="../../../../org/apache/mina/common/IoService.html#getWrittenBytesThroughput--"><code>writtenBytesThroughput</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getLargestReadMessagesThroughput--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLargestReadMessagesThroughput</h4> |
| <pre>double getLargestReadMessagesThroughput()</pre> |
| <div class="block">Returns the maximum of the <a href="../../../../org/apache/mina/common/IoService.html#getReadMessagesThroughput--"><code>readMessagesThroughput</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getLargestWrittenMessagesThroughput--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLargestWrittenMessagesThroughput</h4> |
| <pre>double getLargestWrittenMessagesThroughput()</pre> |
| <div class="block">Returns the maximum of the <a href="../../../../org/apache/mina/common/IoService.html#getWrittenMessagesThroughput--"><code>writtenMessagesThroughput</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getThroughputCalculationInterval--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getThroughputCalculationInterval</h4> |
| <pre>int getThroughputCalculationInterval()</pre> |
| <div class="block">Returns the interval (seconds) between each throughput calculation. |
| The default value is <tt>3</tt> seconds.</div> |
| </li> |
| </ul> |
| <a name="getThroughputCalculationIntervalInMillis--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getThroughputCalculationIntervalInMillis</h4> |
| <pre>long getThroughputCalculationIntervalInMillis()</pre> |
| <div class="block">Returns the interval (milliseconds) between each throughput calculation. |
| The default value is <tt>3</tt> seconds.</div> |
| </li> |
| </ul> |
| <a name="setThroughputCalculationInterval-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setThroughputCalculationInterval</h4> |
| <pre>void setThroughputCalculationInterval(int throughputCalculationInterval)</pre> |
| <div class="block">Sets the interval (seconds) between each throughput calculation. The |
| default value is <tt>3</tt> seconds.</div> |
| </li> |
| </ul> |
| <a name="getScheduledWriteBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getScheduledWriteBytes</h4> |
| <pre>long getScheduledWriteBytes()</pre> |
| <div class="block">Returns the number of bytes scheduled to be written</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The number of bytes scheduled to be written</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getScheduledWriteMessages--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getScheduledWriteMessages</h4> |
| <pre>long getScheduledWriteMessages()</pre> |
| <div class="block">Returns the number of messages scheduled to be written</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The number of messages scheduled to be written</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="broadcast-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>broadcast</h4> |
| <pre>java.util.Set<<a href="../../../../org/apache/mina/common/WriteFuture.html" title="interface in org.apache.mina.common">WriteFuture</a>> broadcast(java.lang.Object message)</pre> |
| <div class="block">Writes the specified <code>message</code> to all the <a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><code>IoSession</code></a>s |
| managed by this service. This method is a convenience shortcut for |
| <a href="../../../../org/apache/mina/common/IoUtil.html#broadcast-java.lang.Object-java.util.Collection-"><code>IoUtil.broadcast(Object, Collection)</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getSessionDataStructureFactory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionDataStructureFactory</h4> |
| <pre><a href="../../../../org/apache/mina/common/IoSessionDataStructureFactory.html" title="interface in org.apache.mina.common">IoSessionDataStructureFactory</a> getSessionDataStructureFactory()</pre> |
| <div class="block">Returns the <a href="../../../../org/apache/mina/common/IoSessionDataStructureFactory.html" title="interface in org.apache.mina.common"><code>IoSessionDataStructureFactory</code></a> that provides |
| related data structures for a new session created by this service.</div> |
| </li> |
| </ul> |
| <a name="setSessionDataStructureFactory-org.apache.mina.common.IoSessionDataStructureFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setSessionDataStructureFactory</h4> |
| <pre>void setSessionDataStructureFactory(<a href="../../../../org/apache/mina/common/IoSessionDataStructureFactory.html" title="interface in org.apache.mina.common">IoSessionDataStructureFactory</a> sessionDataStructureFactory)</pre> |
| <div class="block">Sets the <a href="../../../../org/apache/mina/common/IoSessionDataStructureFactory.html" title="interface in org.apache.mina.common"><code>IoSessionDataStructureFactory</code></a> that provides |
| related data structures for a new session created by this service.</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/IoService.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/IoProcessor.html" title="interface in org.apache.mina.common"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/mina/common/IoServiceListener.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/IoService.html" target="_top">Frames</a></li> |
| <li><a href="IoService.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> |