From c344058a6ff84b42721455b791549f71b88d6912 Mon Sep 17 00:00:00 2001
From: Trustin Lee <trustin@gmail.com>
Date: Tue, 2 Sep 2008 07:33:01 +0000
Subject: [PATCH] * Interpretation -> Meaning * Added more explanation to
 ChannelState

---
 .../channel/ChannelDownstreamHandler.java     |  2 +-
 .../org/jboss/netty/channel/ChannelState.java | 44 ++++++++++++++-----
 2 files changed, 35 insertions(+), 11 deletions(-)

diff --git a/src/main/java/org/jboss/netty/channel/ChannelDownstreamHandler.java b/src/main/java/org/jboss/netty/channel/ChannelDownstreamHandler.java
index e6b0c209df..1280045272 100644
--- a/src/main/java/org/jboss/netty/channel/ChannelDownstreamHandler.java
+++ b/src/main/java/org/jboss/netty/channel/ChannelDownstreamHandler.java
@@ -42,7 +42,7 @@ import java.net.SocketAddress;
  *
  * <table border="1" cellspacing="0" cellpadding="6">
  * <tr>
- * <th>Event type and condition</th><th>Interperatation</th>
+ * <th>Event type and condition</th><th>Meaning</th>
  * </tr>
  * <tr>
  * <td>{@link MessageEvent}</td><td>Send a message to the {@link Channel}.</td>
diff --git a/src/main/java/org/jboss/netty/channel/ChannelState.java b/src/main/java/org/jboss/netty/channel/ChannelState.java
index ccca3580ea..158ac1a88c 100644
--- a/src/main/java/org/jboss/netty/channel/ChannelState.java
+++ b/src/main/java/org/jboss/netty/channel/ChannelState.java
@@ -25,33 +25,57 @@ package org.jboss.netty.channel;
 import java.net.SocketAddress;
 
 /**
- * Represents the current state of a {@link Channel} combined with the
- * {@linkplain ChannelStateEvent#getValue() value} of a {@link ChannelStateEvent}.
+ * Represents the current or requested state of a {@link Channel}.
+ * <p>
+ * The state of a {@link Channel} is interpreted differently depending on the
+ * {@linkplain ChannelStateEvent#getValue() value} of a {@link ChannelStateEvent}
+ * and the direction of the event propagation in a {@link ChannelPipeline}:
  *
  * <table border="1" cellspacing="0" cellpadding="6">
  * <tr>
- * <th>State</th><th>Value</th><th>Description</th>
+ * <th>Direction</th><th>State</th><th>Value</th><th>Meaning</th>
  * </tr>
  * <tr>
- * <td>{@link #OPEN}</td><td>{@code true}</td><td>The channel is open.</td>
+ * <td>Upstream</td><td>{@link #OPEN}</td><td>{@code true}</td><td>The channel is open.</td>
  * </tr>
  * <tr>
- * <td>{@link #OPEN}</td><td>{@code false}</td><td>The channel is closed.</td>
+ * <td>Upstream</td><td>{@link #OPEN}</td><td>{@code false}</td><td>The channel is closed.</td>
  * </tr>
  * <tr>
- * <td>{@link #BOUND}</td><td>{@link SocketAddress}</td><td>The channel is bound to a local address.</td>
+ * <td>Upstream</td><td>{@link #BOUND}</td><td>{@link SocketAddress}</td><td>The channel is bound to a local address.</td>
  * </tr>
  * <tr>
- * <td>{@link #BOUND}</td><td>{@code null}</td><td>The channel is unbound to a local address.</td>
+ * <td>Upstream</td><td>{@link #BOUND}</td><td>{@code null}</td><td>The channel is unbound to a local address.</td>
  * </tr>
  * <tr>
- * <td>{@link #CONNECTED}</td><td>{link SocketAddress}</td><td>The channel is connected to a remote address.</td>
+ * <td>Upstream</td><td>{@link #CONNECTED}</td><td>{@link SocketAddress}</td><td>The channel is connected to a remote address.</td>
  * </tr>
  * <tr>
- * <td>{@link #CONNECTED}</td><td>{@code null}</td><td>The channel is disconnected from a remote address.</td>
+ * <td>Upstream</td><td>{@link #CONNECTED}</td><td>{@code null}</td><td>The channel is disconnected from a remote address.</td>
  * </tr>
  * <tr>
- * <td>{@link #INTEREST_OPS}</td><td>an integer</td><td>The channel interestOps has been changed.</td>
+ * <td>Upstream</td><td>{@link #INTEREST_OPS}</td><td>an integer</td><td>The channel interestOps has been changed.</td>
+ * </tr>
+ * <tr>
+ * <td>Downstream</td><td>{@link #OPEN}</td><td>{@code true}</td><td>N/A</td>
+ * </tr>
+ * <tr>
+ * <td>Downstream</td><td>{@link #OPEN}</td><td>{@code false}</td><td>Close the channel.</td>
+ * </tr>
+ * <tr>
+ * <td>Downstream</td><td>{@link #BOUND}</td><td>{@link SocketAddress}</td><td>Bind the channel to the specified local address.</td>
+ * </tr>
+ * <tr>
+ * <td>Downstream</td><td>{@link #BOUND}</td><td>{@code null}</td><td>Unbind the channel from the current local address.</td>
+ * </tr>
+ * <tr>
+ * <td>Downstream</td><td>{@link #CONNECTED}</td><td>{@link SocketAddress}</td><td>Connect the channel to the specified remote address.</td>
+ * </tr>
+ * <tr>
+ * <td>Downstream</td><td>{@link #CONNECTED}</td><td>{@code null}</td><td>Disconnect the channel from the current remote address.</td>
+ * </tr>
+ * <tr>
+ * <td>Downstream</td><td>{@link #INTEREST_OPS}</td><td>an integer</td><td>Change the interestOps of the channel.</td>
  * </tr>
  * </table>
  * <p>