svn commit: r594478 - /mina/trunk/core/src/main/java/org/apache/mina/common/IoSession.java

[tr...@apache.org]

Author: trustin
Date: Tue Nov 13 02:51:42 2007
New Revision: 594478

URL: http://svn.apache.org/viewvc?rev=594478&view=rev
Log:
More explanation for read operation

Modified:
    mina/trunk/core/src/main/java/org/apache/mina/common/IoSession.java

Modified: mina/trunk/core/src/main/java/org/apache/mina/common/IoSession.java
URL: http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/common/IoSession.java?rev=594478&r1=594477&r2=594478&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/common/IoSession.java (original)
+++ mina/trunk/core/src/main/java/org/apache/mina/common/IoSession.java Tue Nov 13 02:51:42 2007
@@ -80,6 +80,15 @@
     TransportMetadata getTransportMetadata();
     
     /**
+     * Returns a {@link ReadFuture} which is notified when a new message is
+     * received, the connection is closed or an exception is caught.  This
+     * operation is especially useful when you implement a client application.
+     * However, please note that this operation is disabled by default and
+     * throw {@link IllegalStateException} because all received events must be
+     * queued somewhere to support this operation, possibly leading to memory
+     * leak.  This means you have to keep calling {@link #read()} once you
+     * enabled this operation.  To enable this oepration, please call
+     * {@link IoSessionConfig#setUseReadOperation(boolean)} with <tt>true</tt>. 
      * 
      * @throws IllegalStateException if
      * {@link IoSessionConfig#setUseReadOperation(boolean) useReadOperation}