From d0d99ff6bc8f93831ac28ed1e4f5a9571086f57a Mon Sep 17 00:00:00 2001 From: Trustin Lee Date: Wed, 24 Sep 2008 10:46:58 +0000 Subject: [PATCH] More detailed explanation on ChannelFuture --- .../org/jboss/netty/channel/ChannelFuture.java | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/src/main/java/org/jboss/netty/channel/ChannelFuture.java b/src/main/java/org/jboss/netty/channel/ChannelFuture.java index bb5ecf092e..684a19b954 100644 --- a/src/main/java/org/jboss/netty/channel/ChannelFuture.java +++ b/src/main/java/org/jboss/netty/channel/ChannelFuture.java @@ -25,11 +25,18 @@ package org.jboss.netty.channel; import java.util.concurrent.TimeUnit; /** - * The result of an asynchronous {@link Channel} I/O operation. Methods are - * provided to check if the I/O operation is complete, to wait for its - * completion, and to retrieve the result of the I/O operation. It also allows - * you to add more than one {@link ChannelFutureListener} so you can get - * notified when the I/O operation is complete. + * The result of an asynchronous {@link Channel} I/O operation. + *

+ * All I/O operations in Netty are asynchronous. It means any I/O calls will + * return immediately with no guarantee that the requested I/O operation has + * been completed at the end of the call. Instead, you will be returned with + * a {@link ChannelFuture} instance which tells you when the requested I/O + * operation has succeeded, failed, or canceled. + *

+ * Various methods are provided to let you check if the I/O operation has been + * completed, wait for the completion, and retrieve the result of the I/O + * operation. It also allows you to add more than one {@link ChannelFutureListener} + * so you can get notified when the I/O operation has been completed. * * @author The Netty Project (netty-dev@lists.jboss.org) * @author Trustin Lee (tlee@redhat.com)