| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_191) on Sat Mar 16 10:16:14 CET 2019 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>IoSession (Apache MINA 1.1.3 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="IoSession (Apache MINA 1.1.3 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}; |
| 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/IoSession.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/IoServiceListener.html" title="interface in org.apache.mina.common"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/mina/common/IoSessionConfig.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/IoSession.html" target="_top">Frames</a></li> |
| <li><a href="IoSession.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 IoSession" class="title">Interface IoSession</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/common/BroadcastIoSession.html" title="interface in org.apache.mina.common">BroadcastIoSession</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">IoSession</span></pre> |
| <div class="block">A handle which represents connection between two endpoints regardless of |
| transport types. |
| <p> |
| <a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><code>IoSession</code></a> provides user-defined attributes. User-defined attributes |
| are application-specific data which is associated with a session. |
| It often contains objects that represents the state of a higher-level protocol |
| and becomes a way to exchange data between filters and handlers. |
| |
| <h3>Adjusting Transport Type Specific Properties</h3> |
| <p> |
| You can simply downcast the session to an appropriate subclass. |
| </p> |
| |
| <h3>Thread Safety</h3> |
| <p> |
| <a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><code>IoSession</code></a> is thread-safe. But please note that performing |
| more than one <a href="../../../../org/apache/mina/common/IoSession.html#write-java.lang.Object-"><code>write(Object)</code></a> calls at the same time will |
| cause the <a href="../../../../org/apache/mina/common/IoFilter.html#filterWrite-org.apache.mina.common.IoFilter.NextFilter-org.apache.mina.common.IoSession-org.apache.mina.common.IoFilter.WriteRequest-"><code>IoFilter.filterWrite(IoFilter.NextFilter, IoSession, IoFilter.WriteRequest)</code></a> |
| is executed simnutaneously, and therefore you have to make sure the |
| <a href="../../../../org/apache/mina/common/IoFilter.html" title="interface in org.apache.mina.common"><code>IoFilter</code></a> implementations you're using are thread-safe, too. |
| </p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Version:</span></dt> |
| <dd>$Rev: 555855 $, $Date: 2007-07-13 05:19:00 +0200 (Fri, 13 Jul 2007) $</dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>The Apache Directory Project (mina-dev@directory.apache.org)</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </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><a href="../../../../org/apache/mina/common/CloseFuture.html" title="interface in org.apache.mina.common">CloseFuture</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#close--">close</a></span>()</code> |
| <div class="block">Closes this session immediately.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#containsAttribute-java.lang.String-">containsAttribute</a></span>(java.lang.String key)</code> |
| <div class="block">Returns <tt>true</tt> if this session contains the attribute with |
| the specified <tt>key</tt>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#getAttachment--">getAttachment</a></span>()</code> |
| <div class="block">Returns an attachment of this session.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#getAttribute-java.lang.String-">getAttribute</a></span>(java.lang.String key)</code> |
| <div class="block">Returns the value of user-defined attribute of this session.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.util.Set<java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#getAttributeKeys--">getAttributeKeys</a></span>()</code> |
| <div class="block">Returns the set of keys of all user-defined attributes.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/mina/common/CloseFuture.html" title="interface in org.apache.mina.common">CloseFuture</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#getCloseFuture--">getCloseFuture</a></span>()</code> |
| <div class="block">Returns the <a href="../../../../org/apache/mina/common/CloseFuture.html" title="interface in org.apache.mina.common"><code>CloseFuture</code></a> of this session.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <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/IoSession.html#getConfig--">getConfig</a></span>()</code> |
| <div class="block">Returns the configuration of this session.</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/IoSession.html#getCreationTime--">getCreationTime</a></span>()</code> |
| <div class="block">Returns the time in millis when this session is created.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/mina/common/IoFilterChain.html" title="interface in org.apache.mina.common">IoFilterChain</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#getFilterChain--">getFilterChain</a></span>()</code> |
| <div class="block">Returns the filter chain that only affects this session.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <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/IoSession.html#getHandler--">getHandler</a></span>()</code> |
| <div class="block">Returns the <a href="../../../../org/apache/mina/common/IoHandler.html" title="interface in org.apache.mina.common"><code>IoHandler</code></a> which handles this session.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.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>sessionIdle</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="i11" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.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="i12" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.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="i13" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.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 millis when the last <tt>sessionIdle</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="i14" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#getLastIoTime--">getLastIoTime</a></span>()</code> |
| <div class="block">Returns the time in millis when I/O occurred lastly.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#getLastReadTime--">getLastReadTime</a></span>()</code> |
| <div class="block">Returns the time in millis when read operation occurred lastly.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#getLastWriteTime--">getLastWriteTime</a></span>()</code> |
| <div class="block">Returns the time in millis when write operation occurred lastly.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>java.net.SocketAddress</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#getLocalAddress--">getLocalAddress</a></span>()</code> |
| <div class="block">Returns the socket address of local machine which is associated with this |
| session.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#getReadBytes--">getReadBytes</a></span>()</code> |
| <div class="block">Returns the total number of bytes which were read from this session.</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/IoSession.html#getReadMessages--">getReadMessages</a></span>()</code> |
| <div class="block">Returns the total number of messages which were read and decoded from this session.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>java.net.SocketAddress</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#getRemoteAddress--">getRemoteAddress</a></span>()</code> |
| <div class="block">Returns the socket address of remote peer.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#getScheduledWriteBytes--">getScheduledWriteBytes</a></span>()</code> |
| <div class="block">Returns the number of bytes which are scheduled to be written to this |
| session.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#getScheduledWriteRequests--">getScheduledWriteRequests</a></span>()</code> |
| <div class="block">Returns the number of write requests which are scheduled to be written |
| to this session.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common">IoService</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#getService--">getService</a></span>()</code> |
| <div class="block">Returns the <a href="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common"><code>IoService</code></a> which provides I/O service to this session.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>java.net.SocketAddress</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#getServiceAddress--">getServiceAddress</a></span>()</code> |
| <div class="block">Returns the socket address of the <a href="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common"><code>IoService</code></a> listens to to manage |
| this session.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/mina/common/IoServiceConfig.html" title="interface in org.apache.mina.common">IoServiceConfig</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#getServiceConfig--">getServiceConfig</a></span>()</code> |
| <div class="block">Returns the <a href="../../../../org/apache/mina/common/IoServiceConfig.html" title="interface in org.apache.mina.common"><code>IoServiceConfig</code></a> of this session.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/mina/common/TrafficMask.html" title="class in org.apache.mina.common">TrafficMask</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#getTrafficMask--">getTrafficMask</a></span>()</code> |
| <div class="block">Returns the current <a href="../../../../org/apache/mina/common/TrafficMask.html" title="class in org.apache.mina.common"><code>TrafficMask</code></a> of this session.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/mina/common/TransportType.html" title="class in org.apache.mina.common">TransportType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#getTransportType--">getTransportType</a></span>()</code> |
| <div class="block">Returns transport type of this session.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#getWriteTimeout--">getWriteTimeout</a></span>()</code> |
| <div class="block">Returns write timeout in seconds.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#getWriteTimeoutInMillis--">getWriteTimeoutInMillis</a></span>()</code> |
| <div class="block">Returns write timeout in milliseconds.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#getWrittenBytes--">getWrittenBytes</a></span>()</code> |
| <div class="block">Returns the total number of bytes which were written to this session.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#getWrittenMessages--">getWrittenMessages</a></span>()</code> |
| <div class="block">Returns the total number of messages which were written and encoded by this session.</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/IoSession.html#getWrittenWriteRequests--">getWrittenWriteRequests</a></span>()</code> |
| <div class="block">Returns the total number of write requests which were written to this session.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#isClosing--">isClosing</a></span>()</code> |
| <div class="block">Returns <code>true</tt> if and only if this session is being closed |
| (but not disconnected yet) or is closed.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#isConnected--">isConnected</a></span>()</code> |
| <div class="block">Returns <code>true</code> if this session is connected with remote peer.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.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 session 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="i36" class="altColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#removeAttribute-java.lang.String-">removeAttribute</a></span>(java.lang.String key)</code> |
| <div class="block">Removes a user-defined attribute with the specified key.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#resumeRead--">resumeRead</a></span>()</code> |
| <div class="block">A shortcut method for <a href="../../../../org/apache/mina/common/IoSession.html#setTrafficMask-org.apache.mina.common.TrafficMask-"><code>setTrafficMask(TrafficMask)</code></a> that |
| resumes read operations for this session.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#resumeWrite--">resumeWrite</a></span>()</code> |
| <div class="block">A shortcut method for <a href="../../../../org/apache/mina/common/IoSession.html#setTrafficMask-org.apache.mina.common.TrafficMask-"><code>setTrafficMask(TrafficMask)</code></a> that |
| resumes write operations for this session.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#setAttachment-java.lang.Object-">setAttachment</a></span>(java.lang.Object attachment)</code> |
| <div class="block">Sets an attachment of this session.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#setAttribute-java.lang.String-">setAttribute</a></span>(java.lang.String key)</code> |
| <div class="block">Sets a user defined attribute without a value.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#setAttribute-java.lang.String-java.lang.Object-">setAttribute</a></span>(java.lang.String key, |
| java.lang.Object value)</code> |
| <div class="block">Sets a user-defined attribute.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.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="i43" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#setTrafficMask-org.apache.mina.common.TrafficMask-">setTrafficMask</a></span>(<a href="../../../../org/apache/mina/common/TrafficMask.html" title="class in org.apache.mina.common">TrafficMask</a> trafficMask)</code> |
| <div class="block">Sets the <a href="../../../../org/apache/mina/common/TrafficMask.html" title="class in org.apache.mina.common"><code>TrafficMask</code></a> of this session which will result |
| the parent <a href="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common"><code>IoService</code></a> to start to control the traffic |
| of this session immediately.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#setWriteTimeout-int-">setWriteTimeout</a></span>(int writeTimeout)</code> |
| <div class="block">Sets write timeout in seconds.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#suspendRead--">suspendRead</a></span>()</code> |
| <div class="block">A shortcut method for <a href="../../../../org/apache/mina/common/IoSession.html#setTrafficMask-org.apache.mina.common.TrafficMask-"><code>setTrafficMask(TrafficMask)</code></a> that |
| suspends read operations for this session.</div> |
| </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IoSession.html#suspendWrite--">suspendWrite</a></span>()</code> |
| <div class="block">A shortcut method for <a href="../../../../org/apache/mina/common/IoSession.html#setTrafficMask-org.apache.mina.common.TrafficMask-"><code>setTrafficMask(TrafficMask)</code></a> that |
| suspends write operations for this session.</div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code><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/IoSession.html#write-java.lang.Object-">write</a></span>(java.lang.Object message)</code> |
| <div class="block">Writes the specified <code>message</code> to remote peer.</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="getService--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getService</h4> |
| <pre><a href="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common">IoService</a> getService()</pre> |
| <div class="block">Returns the <a href="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common"><code>IoService</code></a> which provides I/O service to this session.</div> |
| </li> |
| </ul> |
| <a name="getServiceConfig--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServiceConfig</h4> |
| <pre><a href="../../../../org/apache/mina/common/IoServiceConfig.html" title="interface in org.apache.mina.common">IoServiceConfig</a> getServiceConfig()</pre> |
| <div class="block">Returns the <a href="../../../../org/apache/mina/common/IoServiceConfig.html" title="interface in org.apache.mina.common"><code>IoServiceConfig</code></a> of this session.</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 <a href="../../../../org/apache/mina/common/IoHandler.html" title="interface in org.apache.mina.common"><code>IoHandler</code></a> which handles this session.</div> |
| </li> |
| </ul> |
| <a name="getConfig--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfig</h4> |
| <pre><a href="../../../../org/apache/mina/common/IoSessionConfig.html" title="interface in org.apache.mina.common">IoSessionConfig</a> getConfig()</pre> |
| <div class="block">Returns the configuration of this session.</div> |
| </li> |
| </ul> |
| <a name="getFilterChain--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFilterChain</h4> |
| <pre><a href="../../../../org/apache/mina/common/IoFilterChain.html" title="interface in org.apache.mina.common">IoFilterChain</a> getFilterChain()</pre> |
| <div class="block">Returns the filter chain that only affects this session.</div> |
| </li> |
| </ul> |
| <a name="write-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre><a href="../../../../org/apache/mina/common/WriteFuture.html" title="interface in org.apache.mina.common">WriteFuture</a> write(java.lang.Object message)</pre> |
| <div class="block">Writes the specified <code>message</code> to remote peer. This |
| operation is asynchronous; <a href="../../../../org/apache/mina/common/IoHandler.html#messageSent-org.apache.mina.common.IoSession-java.lang.Object-"><code>IoHandler.messageSent(IoSession, Object)</code></a> |
| will be invoked when the message is actually sent to remote peer. |
| You can also wait for the returned <a href="../../../../org/apache/mina/common/WriteFuture.html" title="interface in org.apache.mina.common"><code>WriteFuture</code></a> if you want |
| to wait for the message actually written.</div> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre><a href="../../../../org/apache/mina/common/CloseFuture.html" title="interface in org.apache.mina.common">CloseFuture</a> close()</pre> |
| <div class="block">Closes this session immediately. This operation is asynthronous. |
| Wait for the returned <a href="../../../../org/apache/mina/common/CloseFuture.html" title="interface in org.apache.mina.common"><code>CloseFuture</code></a> if you want to wait for |
| the session actually closed.</div> |
| </li> |
| </ul> |
| <a name="getAttachment--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttachment</h4> |
| <pre>java.lang.Object getAttachment()</pre> |
| <div class="block">Returns an attachment of this session. |
| This method is identical with <tt>getAttribute( "" )</tt>.</div> |
| </li> |
| </ul> |
| <a name="setAttachment-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAttachment</h4> |
| <pre>java.lang.Object setAttachment(java.lang.Object attachment)</pre> |
| <div class="block">Sets an attachment of this session. |
| This method is identical with <tt>setAttribute( "", attachment )</tt>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Old attachment. <tt>null</tt> if it is new.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAttribute-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttribute</h4> |
| <pre>java.lang.Object getAttribute(java.lang.String key)</pre> |
| <div class="block">Returns the value of user-defined attribute of this session.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the key of the attribute</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><tt>null</tt> if there is no attribute with the specified key</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAttribute-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAttribute</h4> |
| <pre>java.lang.Object setAttribute(java.lang.String key, |
| java.lang.Object value)</pre> |
| <div class="block">Sets a user-defined attribute.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the key of the attribute</dd> |
| <dd><code>value</code> - the value of the attribute</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The old value of the attribute. <tt>null</tt> if it is new.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAttribute-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAttribute</h4> |
| <pre>java.lang.Object setAttribute(java.lang.String key)</pre> |
| <div class="block">Sets a user defined attribute without a value. This is useful when |
| you just want to put a 'mark' attribute. Its value is set to |
| <code>Boolean.TRUE</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the key of the attribute</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The old value of the attribute. <tt>null</tt> if it is new.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeAttribute-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAttribute</h4> |
| <pre>java.lang.Object removeAttribute(java.lang.String key)</pre> |
| <div class="block">Removes a user-defined attribute with the specified key.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The old value of the attribute. <tt>null</tt> if not found.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="containsAttribute-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>containsAttribute</h4> |
| <pre>boolean containsAttribute(java.lang.String key)</pre> |
| <div class="block">Returns <tt>true</tt> if this session contains the attribute with |
| the specified <tt>key</tt>.</div> |
| </li> |
| </ul> |
| <a name="getAttributeKeys--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttributeKeys</h4> |
| <pre>java.util.Set<java.lang.String> getAttributeKeys()</pre> |
| <div class="block">Returns the set of keys of all user-defined attributes.</div> |
| </li> |
| </ul> |
| <a name="getTransportType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTransportType</h4> |
| <pre><a href="../../../../org/apache/mina/common/TransportType.html" title="class in org.apache.mina.common">TransportType</a> getTransportType()</pre> |
| <div class="block">Returns transport type of this session.</div> |
| </li> |
| </ul> |
| <a name="isConnected--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isConnected</h4> |
| <pre>boolean isConnected()</pre> |
| <div class="block">Returns <code>true</code> if this session is connected with remote peer.</div> |
| </li> |
| </ul> |
| <a name="isClosing--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isClosing</h4> |
| <pre>boolean isClosing()</pre> |
| <div class="block">Returns <code>true</tt> if and only if this session is being closed |
| (but not disconnected yet) or is closed.</div> |
| </li> |
| </ul> |
| <a name="getCloseFuture--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCloseFuture</h4> |
| <pre><a href="../../../../org/apache/mina/common/CloseFuture.html" title="interface in org.apache.mina.common">CloseFuture</a> getCloseFuture()</pre> |
| <div class="block">Returns the <a href="../../../../org/apache/mina/common/CloseFuture.html" title="interface in org.apache.mina.common"><code>CloseFuture</code></a> of this session. This method returns |
| the same instance whenever user calls it.</div> |
| </li> |
| </ul> |
| <a name="getRemoteAddress--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemoteAddress</h4> |
| <pre>java.net.SocketAddress getRemoteAddress()</pre> |
| <div class="block">Returns the socket address of remote peer.</div> |
| </li> |
| </ul> |
| <a name="getLocalAddress--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocalAddress</h4> |
| <pre>java.net.SocketAddress getLocalAddress()</pre> |
| <div class="block">Returns the socket address of local machine which is associated with this |
| session.</div> |
| </li> |
| </ul> |
| <a name="getServiceAddress--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServiceAddress</h4> |
| <pre>java.net.SocketAddress getServiceAddress()</pre> |
| <div class="block">Returns the socket address of the <a href="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common"><code>IoService</code></a> listens to to manage |
| this session. If this session is managed by <a href="../../../../org/apache/mina/common/IoAcceptor.html" title="interface in org.apache.mina.common"><code>IoAcceptor</code></a>, it |
| returns the <code>SocketAddress</code> which is specified as a parameter of |
| <a href="../../../../org/apache/mina/common/IoAcceptor.html#bind-java.net.SocketAddress-org.apache.mina.common.IoHandler-"><code>IoAcceptor.bind(SocketAddress, IoHandler)</code></a>. If this session is |
| managed by <a href="../../../../org/apache/mina/common/IoConnector.html" title="interface in org.apache.mina.common"><code>IoConnector</code></a>, this method returns the same address with |
| that of <a href="../../../../org/apache/mina/common/IoSession.html#getRemoteAddress--"><code>getRemoteAddress()</code></a>.</div> |
| </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="getWriteTimeout--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWriteTimeout</h4> |
| <pre>int getWriteTimeout()</pre> |
| <div class="block">Returns write timeout in seconds.</div> |
| </li> |
| </ul> |
| <a name="getWriteTimeoutInMillis--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWriteTimeoutInMillis</h4> |
| <pre>long getWriteTimeoutInMillis()</pre> |
| <div class="block">Returns write timeout in milliseconds.</div> |
| </li> |
| </ul> |
| <a name="setWriteTimeout-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setWriteTimeout</h4> |
| <pre>void setWriteTimeout(int writeTimeout)</pre> |
| <div class="block">Sets write timeout in seconds.</div> |
| </li> |
| </ul> |
| <a name="getTrafficMask--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTrafficMask</h4> |
| <pre><a href="../../../../org/apache/mina/common/TrafficMask.html" title="class in org.apache.mina.common">TrafficMask</a> getTrafficMask()</pre> |
| <div class="block">Returns the current <a href="../../../../org/apache/mina/common/TrafficMask.html" title="class in org.apache.mina.common"><code>TrafficMask</code></a> of this session.</div> |
| </li> |
| </ul> |
| <a name="setTrafficMask-org.apache.mina.common.TrafficMask-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTrafficMask</h4> |
| <pre>void setTrafficMask(<a href="../../../../org/apache/mina/common/TrafficMask.html" title="class in org.apache.mina.common">TrafficMask</a> trafficMask)</pre> |
| <div class="block">Sets the <a href="../../../../org/apache/mina/common/TrafficMask.html" title="class in org.apache.mina.common"><code>TrafficMask</code></a> of this session which will result |
| the parent <a href="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common"><code>IoService</code></a> to start to control the traffic |
| of this session immediately.</div> |
| </li> |
| </ul> |
| <a name="suspendRead--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>suspendRead</h4> |
| <pre>void suspendRead()</pre> |
| <div class="block">A shortcut method for <a href="../../../../org/apache/mina/common/IoSession.html#setTrafficMask-org.apache.mina.common.TrafficMask-"><code>setTrafficMask(TrafficMask)</code></a> that |
| suspends read operations for this session.</div> |
| </li> |
| </ul> |
| <a name="suspendWrite--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>suspendWrite</h4> |
| <pre>void suspendWrite()</pre> |
| <div class="block">A shortcut method for <a href="../../../../org/apache/mina/common/IoSession.html#setTrafficMask-org.apache.mina.common.TrafficMask-"><code>setTrafficMask(TrafficMask)</code></a> that |
| suspends write operations for this session.</div> |
| </li> |
| </ul> |
| <a name="resumeRead--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resumeRead</h4> |
| <pre>void resumeRead()</pre> |
| <div class="block">A shortcut method for <a href="../../../../org/apache/mina/common/IoSession.html#setTrafficMask-org.apache.mina.common.TrafficMask-"><code>setTrafficMask(TrafficMask)</code></a> that |
| resumes read operations for this session.</div> |
| </li> |
| </ul> |
| <a name="resumeWrite--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resumeWrite</h4> |
| <pre>void resumeWrite()</pre> |
| <div class="block">A shortcut method for <a href="../../../../org/apache/mina/common/IoSession.html#setTrafficMask-org.apache.mina.common.TrafficMask-"><code>setTrafficMask(TrafficMask)</code></a> that |
| resumes write operations for this session.</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 total number of bytes which were read from this session.</div> |
| </li> |
| </ul> |
| <a name="getWrittenBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWrittenBytes</h4> |
| <pre>long getWrittenBytes()</pre> |
| <div class="block">Returns the total number of bytes which were written to this session.</div> |
| </li> |
| </ul> |
| <a name="getReadMessages--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReadMessages</h4> |
| <pre>long getReadMessages()</pre> |
| <div class="block">Returns the total number of messages which were read and decoded from this session.</div> |
| </li> |
| </ul> |
| <a name="getWrittenMessages--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWrittenMessages</h4> |
| <pre>long getWrittenMessages()</pre> |
| <div class="block">Returns the total number of messages which were written and encoded by this session.</div> |
| </li> |
| </ul> |
| <a name="getWrittenWriteRequests--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWrittenWriteRequests</h4> |
| <pre>long getWrittenWriteRequests()</pre> |
| <div class="block">Returns the total number of write requests which were written to this session.</div> |
| </li> |
| </ul> |
| <a name="getScheduledWriteRequests--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getScheduledWriteRequests</h4> |
| <pre>int getScheduledWriteRequests()</pre> |
| <div class="block">Returns the number of write requests which are scheduled to be written |
| to this session.</div> |
| </li> |
| </ul> |
| <a name="getScheduledWriteBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getScheduledWriteBytes</h4> |
| <pre>int getScheduledWriteBytes()</pre> |
| <div class="block">Returns the number of bytes which are scheduled to be written to this |
| session.</div> |
| </li> |
| </ul> |
| <a name="getCreationTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCreationTime</h4> |
| <pre>long getCreationTime()</pre> |
| <div class="block">Returns the time in millis when this session is created.</div> |
| </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 session 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="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>sessionIdle</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>sessionIdle</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>sessionIdle</tt> event is fired again without |
| any I/O between two (or more) <tt>sessionIdle</tt> events.</div> |
| </li> |
| </ul> |
| <a name="getLastIdleTime-org.apache.mina.common.IdleStatus-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <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 millis when the last <tt>sessionIdle</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> |
| </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/IoSession.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/IoServiceListener.html" title="interface in org.apache.mina.common"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/mina/common/IoSessionConfig.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/IoSession.html" target="_top">Frames</a></li> |
| <li><a href="IoSession.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2004-2019 <a href="http://mina.apace.org/">Apache MINA Project</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |