blob: 2323568e42672a083c29027a1e5281c6ab0a648c [file] [log] [blame]
<!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 03:33:24 CET 2019 -->
<title>IoProtocolSession (Apache MINA 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="IoProtocolSession (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,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":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/IoProtocolSession.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/protocol/io/IoProtocolConnector.html" title="class in org.apache.mina.protocol.io"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mina/protocol/io/IoProtocolSession.html" target="_top">Frames</a></li>
<li><a href="IoProtocolSession.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.protocol.io</div>
<h2 title="Class IoProtocolSession" class="title">Class IoProtocolSession</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.mina.protocol.io.IoProtocolSession</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>, <a href="../../../../../org/apache/mina/protocol/ProtocolSession.html" title="interface in org.apache.mina.protocol">ProtocolSession</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">IoProtocolSession</span>
extends java.lang.Object
implements <a href="../../../../../org/apache/mina/protocol/ProtocolSession.html" title="interface in org.apache.mina.protocol">ProtocolSession</a></pre>
<div class="block">A <a href="../../../../../org/apache/mina/protocol/ProtocolSession.html" title="interface in org.apache.mina.protocol"><code>ProtocolSession</code></a> that is backed by <a href="../../../../../org/apache/mina/io/IoSession.html" title="interface in org.apache.mina.io"><code>IoSession</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">
<!-- ========== 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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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/protocol/io/IoProtocolSession.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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/protocol/io/IoProtocolSession.html#close-boolean-">close</a></span>(boolean&nbsp;wait)</code>
<div class="block">Closes this session immediately.</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/protocol/io/IoProtocolSession.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/protocol/io/IoProtocolSession.html#getAttribute-java.lang.String-">getAttribute</a></span>(java.lang.String&nbsp;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</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/protocol/io/IoProtocolSession.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/SessionConfig.html" title="interface in org.apache.mina.common">SessionConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/protocol/io/IoProtocolSession.html#getConfig--">getConfig</a></span>()</code>
<div class="block">Returns the configuration of this session.</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/protocol/io/IoProtocolSession.html#getCreationTime--">getCreationTime</a></span>()</code>
<div class="block">Returns the time in millis when this session is created.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/mina/protocol/ProtocolDecoder.html" title="interface in org.apache.mina.protocol">ProtocolDecoder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/protocol/io/IoProtocolSession.html#getDecoder--">getDecoder</a></span>()</code>
<div class="block">Returns the <a href="../../../../../org/apache/mina/protocol/ProtocolDecoder.html" title="interface in org.apache.mina.protocol"><code>ProtocolDecoder</code></a> for this session.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/mina/protocol/ProtocolEncoder.html" title="interface in org.apache.mina.protocol">ProtocolEncoder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/protocol/io/IoProtocolSession.html#getEncoder--">getEncoder</a></span>()</code>
<div class="block">Returns the <a href="../../../../../org/apache/mina/protocol/ProtocolEncoder.html" title="interface in org.apache.mina.protocol"><code>ProtocolEncoder</code></a> for this session.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/mina/protocol/ProtocolFilterChain.html" title="interface in org.apache.mina.protocol">ProtocolFilterChain</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/protocol/io/IoProtocolSession.html#getFilterChain--">getFilterChain</a></span>()</code>
<div class="block">Returns the filter chain that only affects this session.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/mina/protocol/ProtocolHandler.html" title="interface in org.apache.mina.protocol">ProtocolHandler</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/protocol/io/IoProtocolSession.html#getHandler--">getHandler</a></span>()</code>
<div class="block">Returns the <a href="../../../../../org/apache/mina/protocol/ProtocolHandler.html" title="interface in org.apache.mina.protocol"><code>ProtocolHandler</code></a> which handles this session.</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/protocol/io/IoProtocolSession.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>&nbsp;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="i12" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/mina/io/IoSession.html" title="interface in org.apache.mina.io">IoSession</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/protocol/io/IoProtocolSession.html#getIoSession--">getIoSession</a></span>()</code>
<div class="block">Returns the <a href="../../../../../org/apache/mina/io/IoSession.html" title="interface in org.apache.mina.io"><code>IoSession</code></a> this session is backed by.</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/protocol/io/IoProtocolSession.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>&nbsp;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/protocol/io/IoProtocolSession.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/protocol/io/IoProtocolSession.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/protocol/io/IoProtocolSession.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/protocol/io/IoProtocolSession.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/protocol/io/IoProtocolSession.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>java.net.SocketAddress</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/protocol/io/IoProtocolSession.html#getRemoteAddress--">getRemoteAddress</a></span>()</code>
<div class="block">Returns the socket address of remote peer.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/protocol/io/IoProtocolSession.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="i21" 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/protocol/io/IoProtocolSession.html#getTransportType--">getTransportType</a></span>()</code>
<div class="block">Returns transport type of this session.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/protocol/io/IoProtocolSession.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="i23" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/protocol/io/IoProtocolSession.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="i24" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/protocol/io/IoProtocolSession.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="i25" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/protocol/io/IoProtocolSession.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>&nbsp;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="i26" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/protocol/io/IoProtocolSession.html#removeAttribute-java.lang.String-">removeAttribute</a></span>(java.lang.String&nbsp;key)</code>
<div class="block">Removes a user-defined attribute with the specified key.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/protocol/io/IoProtocolSession.html#setAttachment-java.lang.Object-">setAttachment</a></span>(java.lang.Object&nbsp;attachment)</code>
<div class="block">Sets an attachment of this session.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/protocol/io/IoProtocolSession.html#setAttribute-java.lang.String-java.lang.Object-">setAttribute</a></span>(java.lang.String&nbsp;key,
java.lang.Object&nbsp;value)</code>
<div class="block">Sets a user-defined attribute.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/protocol/io/IoProtocolSession.html#write-java.lang.Object-">write</a></span>(java.lang.Object&nbsp;message)</code>
<div class="block">Writes the specified <code>message</code> to remote peer.</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&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getIoSession--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIoSession</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/mina/io/IoSession.html" title="interface in org.apache.mina.io">IoSession</a>&nbsp;getIoSession()</pre>
<div class="block">Returns the <a href="../../../../../org/apache/mina/io/IoSession.html" title="interface in org.apache.mina.io"><code>IoSession</code></a> this session is backed by.</div>
</li>
</ul>
<a name="getFilterChain--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilterChain</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/mina/protocol/ProtocolFilterChain.html" title="interface in org.apache.mina.protocol">ProtocolFilterChain</a>&nbsp;getFilterChain()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/mina/protocol/ProtocolSession.html#getFilterChain--">ProtocolSession</a></code></span></div>
<div class="block">Returns the filter chain that only affects this session.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/protocol/ProtocolSession.html#getFilterChain--">getFilterChain</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/mina/protocol/ProtocolSession.html" title="interface in org.apache.mina.protocol">ProtocolSession</a></code></dd>
</dl>
</li>
</ul>
<a name="getHandler--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHandler</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/mina/protocol/ProtocolHandler.html" title="interface in org.apache.mina.protocol">ProtocolHandler</a>&nbsp;getHandler()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/mina/protocol/ProtocolSession.html#getHandler--">ProtocolSession</a></code></span></div>
<div class="block">Returns the <a href="../../../../../org/apache/mina/protocol/ProtocolHandler.html" title="interface in org.apache.mina.protocol"><code>ProtocolHandler</code></a> which handles this session.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/protocol/ProtocolSession.html#getHandler--">getHandler</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/mina/protocol/ProtocolSession.html" title="interface in org.apache.mina.protocol">ProtocolSession</a></code></dd>
</dl>
</li>
</ul>
<a name="getEncoder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEncoder</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/mina/protocol/ProtocolEncoder.html" title="interface in org.apache.mina.protocol">ProtocolEncoder</a>&nbsp;getEncoder()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/mina/protocol/ProtocolSession.html#getEncoder--">ProtocolSession</a></code></span></div>
<div class="block">Returns the <a href="../../../../../org/apache/mina/protocol/ProtocolEncoder.html" title="interface in org.apache.mina.protocol"><code>ProtocolEncoder</code></a> for this session.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/protocol/ProtocolSession.html#getEncoder--">getEncoder</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/mina/protocol/ProtocolSession.html" title="interface in org.apache.mina.protocol">ProtocolSession</a></code></dd>
</dl>
</li>
</ul>
<a name="getDecoder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDecoder</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/mina/protocol/ProtocolDecoder.html" title="interface in org.apache.mina.protocol">ProtocolDecoder</a>&nbsp;getDecoder()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/mina/protocol/ProtocolSession.html#getDecoder--">ProtocolSession</a></code></span></div>
<div class="block">Returns the <a href="../../../../../org/apache/mina/protocol/ProtocolDecoder.html" title="interface in org.apache.mina.protocol"><code>ProtocolDecoder</code></a> for this session.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/protocol/ProtocolSession.html#getDecoder--">getDecoder</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/mina/protocol/ProtocolSession.html" title="interface in org.apache.mina.protocol">ProtocolSession</a></code></dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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="close-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close(boolean&nbsp;wait)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/mina/common/Session.html#close-boolean-">Session</a></code></span></div>
<div class="block">Closes this session immediately.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/common/Session.html#close-boolean-">close</a></code>&nbsp;in interface&nbsp;<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>wait</code> - <tt>true</tt> if you want to wait until closing process is
complete.</dd>
</dl>
</li>
</ul>
<a name="getAttachment--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttachment</h4>
<pre>public&nbsp;java.lang.Object&nbsp;getAttachment()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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&nbsp;java.lang.Object&nbsp;setAttachment(java.lang.Object&nbsp;attachment)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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&nbsp;java.lang.Object&nbsp;getAttribute(java.lang.String&nbsp;key)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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&nbsp;java.lang.Object&nbsp;setAttribute(java.lang.String&nbsp;key,
java.lang.Object&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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&nbsp;java.lang.Object&nbsp;removeAttribute(java.lang.String&nbsp;key)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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&nbsp;java.util.Set&nbsp;getAttributeKeys()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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="write-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>write</h4>
<pre>public&nbsp;void&nbsp;write(java.lang.Object&nbsp;message)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/mina/protocol/ProtocolSession.html#write-java.lang.Object-">ProtocolSession</a></code></span></div>
<div class="block">Writes the specified <code>message</code> to remote peer. This operation
is asynchronous; <a href="../../../../../org/apache/mina/protocol/ProtocolHandler.html#messageSent-org.apache.mina.protocol.ProtocolSession-java.lang.Object-"><code>ProtocolHandler.messageSent(ProtocolSession, Object)</code></a>
will be invoked when the message is actually sent to remote peer.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/protocol/ProtocolSession.html#write-java.lang.Object-">write</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/mina/protocol/ProtocolSession.html" title="interface in org.apache.mina.protocol">ProtocolSession</a></code></dd>
</dl>
</li>
</ul>
<a name="getWrittenWriteRequests--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWrittenWriteRequests</h4>
<pre>public&nbsp;long&nbsp;getWrittenWriteRequests()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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="getScheduledWriteRequests--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getScheduledWriteRequests</h4>
<pre>public&nbsp;int&nbsp;getScheduledWriteRequests()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/mina/common/Session.html#getScheduledWriteRequests--">Session</a></code></span></div>
<div class="block">Returns the number of write requests which are scheduled to be written
to this session.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/common/Session.html#getScheduledWriteRequests--">getScheduledWriteRequests</a></code>&nbsp;in interface&nbsp;<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="getTransportType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransportType</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/mina/common/TransportType.html" title="class in org.apache.mina.common">TransportType</a>&nbsp;getTransportType()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/mina/common/Session.html#getTransportType--">Session</a></code></span></div>
<div class="block">Returns transport type of this session.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/common/Session.html#getTransportType--">getTransportType</a></code>&nbsp;in interface&nbsp;<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="isConnected--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isConnected</h4>
<pre>public&nbsp;boolean&nbsp;isConnected()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/mina/common/Session.html#isConnected--">Session</a></code></span></div>
<div class="block">Returns <code>true</code> if this session is connected with remote peer.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/common/Session.html#isConnected--">isConnected</a></code>&nbsp;in interface&nbsp;<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="getConfig--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfig</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/mina/common/SessionConfig.html" title="interface in org.apache.mina.common">SessionConfig</a>&nbsp;getConfig()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/mina/common/Session.html#getConfig--">Session</a></code></span></div>
<div class="block">Returns the configuration of this session.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/common/Session.html#getConfig--">getConfig</a></code>&nbsp;in interface&nbsp;<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="getRemoteAddress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteAddress</h4>
<pre>public&nbsp;java.net.SocketAddress&nbsp;getRemoteAddress()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/mina/common/Session.html#getRemoteAddress--">Session</a></code></span></div>
<div class="block">Returns the socket address of remote peer.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/common/Session.html#getRemoteAddress--">getRemoteAddress</a></code>&nbsp;in interface&nbsp;<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="getLocalAddress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalAddress</h4>
<pre>public&nbsp;java.net.SocketAddress&nbsp;getLocalAddress()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/mina/common/Session.html#getLocalAddress--">Session</a></code></span></div>
<div class="block">Returns the socket address of local machine which is associated with this
session.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/common/Session.html#getLocalAddress--">getLocalAddress</a></code>&nbsp;in interface&nbsp;<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&nbsp;long&nbsp;getReadBytes()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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&nbsp;long&nbsp;getWrittenBytes()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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="getCreationTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCreationTime</h4>
<pre>public&nbsp;long&nbsp;getCreationTime()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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&nbsp;long&nbsp;getLastIoTime()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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&nbsp;long&nbsp;getLastReadTime()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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&nbsp;long&nbsp;getLastWriteTime()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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&nbsp;boolean&nbsp;isIdle(<a href="../../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</a>&nbsp;status)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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&nbsp;int&nbsp;getIdleCount(<a href="../../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</a>&nbsp;status)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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="blockListLast">
<li class="blockList">
<h4>getLastIdleTime</h4>
<pre>public&nbsp;long&nbsp;getLastIdleTime(<a href="../../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</a>&nbsp;status)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common">Session</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IoProtocolSession.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/protocol/io/IoProtocolConnector.html" title="class in org.apache.mina.protocol.io"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mina/protocol/io/IoProtocolSession.html" target="_top">Frames</a></li>
<li><a href="IoProtocolSession.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>