blob: cb19a6338bde3d15dbeb3a40ec4d5c4b203ca41e [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 18:07:14 CET 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IdleStatusChecker (Apache MINA 2.0.0-M1 API Documentation)</title>
<meta name="date" content="2019-03-16">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="IdleStatusChecker (Apache MINA 2.0.0-M1 API Documentation)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":9,"i3":9,"i4":9,"i5":9,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/IdleStatusChecker.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/IdleStatus.html" title="class in org.apache.mina.common"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/mina/common/IoAcceptor.html" title="interface in org.apache.mina.common"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/mina/common/IdleStatusChecker.html" target="_top">Frames</a></li>
<li><a href="IdleStatusChecker.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.common</div>
<h2 title="Class IdleStatusChecker" class="title">Class IdleStatusChecker</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.mina.common.IdleStatusChecker</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">IdleStatusChecker</span>
extends java.lang.Object</pre>
<div class="block">Detects idle sessions and fires <tt>sessionIdle</tt> events to them.</div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>$Rev: 525369 $, $Date: 2007-04-04 05:05:11 +0200 (mer., 04 avr. 2007) $</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>The Apache MINA Project (dev@mina.apache.org)</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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/common/IdleStatusChecker.html#addService-org.apache.mina.common.AbstractIoService-">addService</a></span>(<a href="../../../../org/apache/mina/common/AbstractIoService.html" title="class in org.apache.mina.common">AbstractIoService</a>&nbsp;service)</code>&nbsp;</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/common/IdleStatusChecker.html#addSession-org.apache.mina.common.AbstractIoSession-">addSession</a></span>(<a href="../../../../org/apache/mina/common/AbstractIoSession.html" title="class in org.apache.mina.common">AbstractIoSession</a>&nbsp;session)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/mina/common/IdleStatusChecker.html" title="class in org.apache.mina.common">IdleStatusChecker</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IdleStatusChecker.html#getInstance--">getInstance</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IdleStatusChecker.html#notifyIdleness-org.apache.mina.common.IoService-long-">notifyIdleness</a></span>(<a href="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common">IoService</a>&nbsp;service,
long&nbsp;currentTime)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IdleStatusChecker.html#notifyIdleness-java.util.Iterator-long-">notifyIdleness</a></span>(java.util.Iterator&lt;? extends <a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</a>&gt;&nbsp;sessions,
long&nbsp;currentTime)</code>
<div class="block">Fires a <a href="../../../../org/apache/mina/common/IoEventType.html#SESSION_IDLE"><code>IoEventType.SESSION_IDLE</code></a> event to any applicable
sessions in the specified collection.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IdleStatusChecker.html#notifyIdleSession-org.apache.mina.common.IoSession-long-">notifyIdleSession</a></span>(<a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</a>&nbsp;session,
long&nbsp;currentTime)</code>
<div class="block">Fires a <a href="../../../../org/apache/mina/common/IoEventType.html#SESSION_IDLE"><code>IoEventType.SESSION_IDLE</code></a> event if applicable for the
specified <code>session</code>.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IdleStatusChecker.html#removeService-org.apache.mina.common.AbstractIoService-">removeService</a></span>(<a href="../../../../org/apache/mina/common/AbstractIoService.html" title="class in org.apache.mina.common">AbstractIoService</a>&nbsp;service)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/IdleStatusChecker.html#removeSession-org.apache.mina.common.AbstractIoSession-">removeSession</a></span>(<a href="../../../../org/apache/mina/common/AbstractIoSession.html" title="class in org.apache.mina.common">AbstractIoSession</a>&nbsp;session)</code>&nbsp;</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="getInstance--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/mina/common/IdleStatusChecker.html" title="class in org.apache.mina.common">IdleStatusChecker</a>&nbsp;getInstance()</pre>
</li>
</ul>
<a name="addSession-org.apache.mina.common.AbstractIoSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addSession</h4>
<pre>public&nbsp;void&nbsp;addSession(<a href="../../../../org/apache/mina/common/AbstractIoSession.html" title="class in org.apache.mina.common">AbstractIoSession</a>&nbsp;session)</pre>
</li>
</ul>
<a name="addService-org.apache.mina.common.AbstractIoService-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addService</h4>
<pre>public&nbsp;void&nbsp;addService(<a href="../../../../org/apache/mina/common/AbstractIoService.html" title="class in org.apache.mina.common">AbstractIoService</a>&nbsp;service)</pre>
</li>
</ul>
<a name="removeSession-org.apache.mina.common.AbstractIoSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeSession</h4>
<pre>public&nbsp;void&nbsp;removeSession(<a href="../../../../org/apache/mina/common/AbstractIoSession.html" title="class in org.apache.mina.common">AbstractIoSession</a>&nbsp;session)</pre>
</li>
</ul>
<a name="removeService-org.apache.mina.common.AbstractIoService-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeService</h4>
<pre>public&nbsp;void&nbsp;removeService(<a href="../../../../org/apache/mina/common/AbstractIoService.html" title="class in org.apache.mina.common">AbstractIoService</a>&nbsp;service)</pre>
</li>
</ul>
<a name="notifyIdleness-java.util.Iterator-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>notifyIdleness</h4>
<pre>public static&nbsp;void&nbsp;notifyIdleness(java.util.Iterator&lt;? extends <a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</a>&gt;&nbsp;sessions,
long&nbsp;currentTime)</pre>
<div class="block">Fires a <a href="../../../../org/apache/mina/common/IoEventType.html#SESSION_IDLE"><code>IoEventType.SESSION_IDLE</code></a> event to any applicable
sessions in the specified collection.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>currentTime</code> - the current time (i.e. <code>System.currentTimeMillis()</code>)</dd>
</dl>
</li>
</ul>
<a name="notifyIdleness-org.apache.mina.common.IoService-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>notifyIdleness</h4>
<pre>public static&nbsp;void&nbsp;notifyIdleness(<a href="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common">IoService</a>&nbsp;service,
long&nbsp;currentTime)</pre>
</li>
</ul>
<a name="notifyIdleSession-org.apache.mina.common.IoSession-long-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>notifyIdleSession</h4>
<pre>public static&nbsp;void&nbsp;notifyIdleSession(<a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</a>&nbsp;session,
long&nbsp;currentTime)</pre>
<div class="block">Fires a <a href="../../../../org/apache/mina/common/IoEventType.html#SESSION_IDLE"><code>IoEventType.SESSION_IDLE</code></a> event if applicable for the
specified <code>session</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>currentTime</code> - the current time (i.e. <code>System.currentTimeMillis()</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/IdleStatusChecker.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/IdleStatus.html" title="class in org.apache.mina.common"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/mina/common/IoAcceptor.html" title="interface in org.apache.mina.common"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/mina/common/IdleStatusChecker.html" target="_top">Frames</a></li>
<li><a href="IdleStatusChecker.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 ======= -->
<p class="legalCopy"><small>Copyright © 2004-2019 <a href="http://mina.apache.org/">Apache MINA Project</a>. All Rights Reserved.</small></p>
</body>
</html>