| <!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 Fri Mar 15 10:07:11 CET 2019 --> |
| <title>BaseSession (Apache MINA API Documentation)</title> |
| <meta name="date" content="2019-03-15"> |
| <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="BaseSession (Apache MINA API Documentation)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/BaseSession.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>Prev Class</li> |
| <li><a href="../../../../org/apache/mina/common/BaseSessionConfig.html" title="class 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/BaseSession.html" target="_top">Frames</a></li> |
| <li><a href="BaseSession.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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="Class BaseSession" class="title">Class BaseSession</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.mina.common.BaseSession</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common">Session</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">BaseSession</span> |
| extends java.lang.Object |
| implements <a href="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common">Session</a></pre> |
| <div class="block">Base implementation of <a href="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common"><code>Session</code></a>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Version:</span></dt> |
| <dd>$Rev: 326586 $, $Date: 2005-10-19 17:50:29 +0200 (Wed, 19 Oct 2005) $</dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>The Apache Directory Project (dev@directory.apache.org)</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/BaseSession.html#BaseSession--">BaseSession</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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/BaseSession.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>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/BaseSession.html#getAttachment--">getAttachment</a></span>()</code> |
| <div class="block">Returns an attachment of this session.</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/BaseSession.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="i3" class="rowColor"> |
| <td class="colFirst"><code>java.util.Set</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/BaseSession.html#getAttributeKeys--">getAttributeKeys</a></span>()</code> |
| <div class="block">Returns the set of keys of all user-defined attributes.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/BaseSession.html#getCreationTime--">getCreationTime</a></span>()</code> |
| <div class="block">Returns the time in millis when this session is created.</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/BaseSession.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="i6" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/BaseSession.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="i7" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/BaseSession.html#getLastIoTime--">getLastIoTime</a></span>()</code> |
| <div class="block">Returns the time in millis when I/O occurred lastly.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/BaseSession.html#getLastReadTime--">getLastReadTime</a></span>()</code> |
| <div class="block">Returns the time in millis when read operation occurred lastly.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/BaseSession.html#getLastWriteTime--">getLastWriteTime</a></span>()</code> |
| <div class="block">Returns the time in millis when write operation occurred lastly.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/BaseSession.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="i11" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/BaseSession.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="i12" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/BaseSession.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="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/BaseSession.html#increaseIdleCount-org.apache.mina.common.IdleStatus-">increaseIdleCount</a></span>(<a href="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</a> status)</code> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/BaseSession.html#increaseReadBytes-int-">increaseReadBytes</a></span>(int increment)</code> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/BaseSession.html#increaseWrittenBytes-int-">increaseWrittenBytes</a></span>(int increment)</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/BaseSession.html#increaseWrittenWriteRequests--">increaseWrittenWriteRequests</a></span>()</code> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/BaseSession.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="i18" class="altColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/BaseSession.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="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/BaseSession.html#resetIdleCount-org.apache.mina.common.IdleStatus-">resetIdleCount</a></span>(<a href="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</a> status)</code> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/BaseSession.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="i21" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/BaseSession.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> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.mina.common.Session"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.mina.common.<a href="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common">Session</a></h3> |
| <code><a href="../../../../org/apache/mina/common/Session.html#close-boolean-">close</a>, <a href="../../../../org/apache/mina/common/Session.html#getConfig--">getConfig</a>, <a href="../../../../org/apache/mina/common/Session.html#getLocalAddress--">getLocalAddress</a>, <a href="../../../../org/apache/mina/common/Session.html#getRemoteAddress--">getRemoteAddress</a>, <a href="../../../../org/apache/mina/common/Session.html#getScheduledWriteRequests--">getScheduledWriteRequests</a>, <a href="../../../../org/apache/mina/common/Session.html#getTransportType--">getTransportType</a>, <a href="../../../../org/apache/mina/common/Session.html#isConnected--">isConnected</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="BaseSession--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>BaseSession</h4> |
| <pre>protected BaseSession()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/mina/common/Session.html#close--">Session</a></code></span></div> |
| <div class="block">Closes this session immediately. Calling method is identical with |
| calling <tt>close( false )</tt>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/common/Session.html#close--">close</a></code> in interface <code><a href="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common">Session</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAttachment--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttachment</h4> |
| <pre>public java.lang.Object getAttachment()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/mina/common/Session.html#getAttachment--">Session</a></code></span></div> |
| <div class="block">Returns an attachment of this session. |
| This method is identical with <tt>getAttribute( "" )</tt>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/common/Session.html#getAttachment--">getAttachment</a></code> in interface <code><a href="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common">Session</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAttachment-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAttachment</h4> |
| <pre>public java.lang.Object setAttachment(java.lang.Object attachment)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/mina/common/Session.html#setAttachment-java.lang.Object-">Session</a></code></span></div> |
| <div class="block">Sets an attachment of this session. |
| This method is identical with <tt>setAttribute( "", attachment )</tt>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/common/Session.html#setAttachment-java.lang.Object-">setAttachment</a></code> in interface <code><a href="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common">Session</a></code></dd> |
| <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>public java.lang.Object getAttribute(java.lang.String key)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/mina/common/Session.html#getAttribute-java.lang.String-">Session</a></code></span></div> |
| <div class="block">Returns the value of user-defined attribute of this session.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/common/Session.html#getAttribute-java.lang.String-">getAttribute</a></code> in interface <code><a href="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common">Session</a></code></dd> |
| <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>public java.lang.Object setAttribute(java.lang.String key, |
| java.lang.Object value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/mina/common/Session.html#setAttribute-java.lang.String-java.lang.Object-">Session</a></code></span></div> |
| <div class="block">Sets a user-defined attribute.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/common/Session.html#setAttribute-java.lang.String-java.lang.Object-">setAttribute</a></code> in interface <code><a href="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common">Session</a></code></dd> |
| <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="removeAttribute-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAttribute</h4> |
| <pre>public java.lang.Object removeAttribute(java.lang.String key)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/mina/common/Session.html#removeAttribute-java.lang.String-">Session</a></code></span></div> |
| <div class="block">Removes a user-defined attribute with the specified key.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/common/Session.html#removeAttribute-java.lang.String-">removeAttribute</a></code> in interface <code><a href="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common">Session</a></code></dd> |
| <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="getAttributeKeys--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttributeKeys</h4> |
| <pre>public java.util.Set getAttributeKeys()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/mina/common/Session.html#getAttributeKeys--">Session</a></code></span></div> |
| <div class="block">Returns the set of keys of all user-defined attributes.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/common/Session.html#getAttributeKeys--">getAttributeKeys</a></code> in interface <code><a href="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common">Session</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getReadBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReadBytes</h4> |
| <pre>public long getReadBytes()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/mina/common/Session.html#getReadBytes--">Session</a></code></span></div> |
| <div class="block">Returns the total number of bytes which were read from this session.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/common/Session.html#getReadBytes--">getReadBytes</a></code> in interface <code><a href="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common">Session</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getWrittenBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWrittenBytes</h4> |
| <pre>public long getWrittenBytes()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/mina/common/Session.html#getWrittenBytes--">Session</a></code></span></div> |
| <div class="block">Returns the total number of bytes which were written to this session.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/common/Session.html#getWrittenBytes--">getWrittenBytes</a></code> in interface <code><a href="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common">Session</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getWrittenWriteRequests--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWrittenWriteRequests</h4> |
| <pre>public long getWrittenWriteRequests()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/mina/common/Session.html#getWrittenWriteRequests--">Session</a></code></span></div> |
| <div class="block">Returns the total number of write requests which were written to this session.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/common/Session.html#getWrittenWriteRequests--">getWrittenWriteRequests</a></code> in interface <code><a href="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common">Session</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="increaseReadBytes-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>increaseReadBytes</h4> |
| <pre>public void increaseReadBytes(int increment)</pre> |
| </li> |
| </ul> |
| <a name="increaseWrittenBytes-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>increaseWrittenBytes</h4> |
| <pre>public void increaseWrittenBytes(int increment)</pre> |
| </li> |
| </ul> |
| <a name="increaseWrittenWriteRequests--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>increaseWrittenWriteRequests</h4> |
| <pre>public void increaseWrittenWriteRequests()</pre> |
| </li> |
| </ul> |
| <a name="getCreationTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCreationTime</h4> |
| <pre>public long getCreationTime()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/mina/common/Session.html#getCreationTime--">Session</a></code></span></div> |
| <div class="block">Returns the time in millis when this session is created.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/common/Session.html#getCreationTime--">getCreationTime</a></code> in interface <code><a href="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common">Session</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLastIoTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLastIoTime</h4> |
| <pre>public long getLastIoTime()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/mina/common/Session.html#getLastIoTime--">Session</a></code></span></div> |
| <div class="block">Returns the time in millis when I/O occurred lastly.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/common/Session.html#getLastIoTime--">getLastIoTime</a></code> in interface <code><a href="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common">Session</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLastReadTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLastReadTime</h4> |
| <pre>public long getLastReadTime()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/mina/common/Session.html#getLastReadTime--">Session</a></code></span></div> |
| <div class="block">Returns the time in millis when read operation occurred lastly.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/common/Session.html#getLastReadTime--">getLastReadTime</a></code> in interface <code><a href="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common">Session</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLastWriteTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLastWriteTime</h4> |
| <pre>public long getLastWriteTime()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/mina/common/Session.html#getLastWriteTime--">Session</a></code></span></div> |
| <div class="block">Returns the time in millis when write operation occurred lastly.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/common/Session.html#getLastWriteTime--">getLastWriteTime</a></code> in interface <code><a href="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common">Session</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isIdle-org.apache.mina.common.IdleStatus-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isIdle</h4> |
| <pre>public boolean isIdle(<a href="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</a> status)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/mina/common/Session.html#isIdle-org.apache.mina.common.IdleStatus-">Session</a></code></span></div> |
| <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> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/common/Session.html#isIdle-org.apache.mina.common.IdleStatus-">isIdle</a></code> in interface <code><a href="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common">Session</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIdleCount-org.apache.mina.common.IdleStatus-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIdleCount</h4> |
| <pre>public int getIdleCount(<a href="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</a> status)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/mina/common/Session.html#getIdleCount-org.apache.mina.common.IdleStatus-">Session</a></code></span></div> |
| <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> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/common/Session.html#getIdleCount-org.apache.mina.common.IdleStatus-">getIdleCount</a></code> in interface <code><a href="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common">Session</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLastIdleTime-org.apache.mina.common.IdleStatus-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLastIdleTime</h4> |
| <pre>public long getLastIdleTime(<a href="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</a> status)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/mina/common/Session.html#getLastIdleTime-org.apache.mina.common.IdleStatus-">Session</a></code></span></div> |
| <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> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/common/Session.html#getLastIdleTime-org.apache.mina.common.IdleStatus-">getLastIdleTime</a></code> in interface <code><a href="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common">Session</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="increaseIdleCount-org.apache.mina.common.IdleStatus-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>increaseIdleCount</h4> |
| <pre>public void increaseIdleCount(<a href="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</a> status)</pre> |
| </li> |
| </ul> |
| <a name="resetIdleCount-org.apache.mina.common.IdleStatus-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>resetIdleCount</h4> |
| <pre>public void resetIdleCount(<a href="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</a> status)</pre> |
| </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/BaseSession.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>Prev Class</li> |
| <li><a href="../../../../org/apache/mina/common/BaseSessionConfig.html" title="class 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/BaseSession.html" target="_top">Frames</a></li> |
| <li><a href="BaseSession.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |