svn commit: r711930 - /mina/sandbox/jvermillard/mina-cleaning/core/src/main/java/org/apache/mina/core/session/IdleStatusChecker.java

[jv...@apache.org]

Author: jvermillard
Date: Thu Nov  6 10:04:01 2008
New Revision: 711930

URL: http://svn.apache.org/viewvc?rev=711930&view=rev
Log:
comments on IdleStatusChecker

Modified:
    mina/sandbox/jvermillard/mina-cleaning/core/src/main/java/org/apache/mina/core/session/IdleStatusChecker.java

Modified: mina/sandbox/jvermillard/mina-cleaning/core/src/main/java/org/apache/mina/core/session/IdleStatusChecker.java
URL: http://svn.apache.org/viewvc/mina/sandbox/jvermillard/mina-cleaning/core/src/main/java/org/apache/mina/core/session/IdleStatusChecker.java?rev=711930&r1=711929&r2=711930&view=diff
==============================================================================
--- mina/sandbox/jvermillard/mina-cleaning/core/src/main/java/org/apache/mina/core/session/IdleStatusChecker.java (original)
+++ mina/sandbox/jvermillard/mina-cleaning/core/src/main/java/org/apache/mina/core/session/IdleStatusChecker.java Thu Nov  6 10:04:01 2008
@@ -25,6 +25,7 @@
 import org.apache.mina.core.future.CloseFuture;
 import org.apache.mina.core.future.IoFuture;
 import org.apache.mina.core.future.IoFutureListener;
+import org.apache.mina.core.service.IoService;
 import org.apache.mina.util.ConcurrentHashSet;
 
 /**
@@ -74,6 +75,10 @@
         sessions.remove(session);
     }
 
+    /**
+     * get a runnable task able to be scheduled in the {@link IoService} executor.
+     * @return
+     */
     public NotifyingTask getNotifyingTask() {
         return notifyingTask;
     }
@@ -84,6 +89,11 @@
     public class NotifyingTask implements Runnable {
         private volatile boolean cancelled;
         private volatile Thread thread;
+        
+        // we forbid instantiation of this class outside
+        private NotifyingTask() {
+        	
+        }
 
         public void run() {
             thread = Thread.currentThread();
@@ -105,6 +115,9 @@
             }
         }
 
+        /**
+         * stop execution of the task
+         */
         public void cancel() {
             cancelled = true;
             Thread thread = this.thread;