From 267a8cb1d7b58a1b1faf702cb2ab593e01fa4a24 Mon Sep 17 00:00:00 2001
From: Trustin Lee <trustin@gmail.com>
Date: Wed, 3 Sep 2008 03:39:27 +0000
Subject: [PATCH] Added event name column to the table in
 ChannelDownstreamHandler

---
 .../netty/channel/ChannelDownstreamHandler.java      | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/src/main/java/org/jboss/netty/channel/ChannelDownstreamHandler.java b/src/main/java/org/jboss/netty/channel/ChannelDownstreamHandler.java
index 2dd5a6e538..c054120fc1 100644
--- a/src/main/java/org/jboss/netty/channel/ChannelDownstreamHandler.java
+++ b/src/main/java/org/jboss/netty/channel/ChannelDownstreamHandler.java
@@ -44,35 +44,43 @@ import java.net.SocketAddress;
  *
  * <table border="1" cellspacing="0" cellpadding="6">
  * <tr>
- * <th>Event type and condition</th><th>Meaning</th>
+ * <th>Event name</th><th>Event type and condition</th><th>Meaning</th>
  * </tr>
  * <tr>
+ * <td>{@code "write"}</td>
  * <td>{@link MessageEvent}</td><td>Send a message to the {@link Channel}.</td>
  * </tr>
  * <tr>
+ * <td>{@code "bind"}</td>
  * <td>{@link ChannelStateEvent}<br/>(state = {@link ChannelState#BOUND BOUND}, value = {@link SocketAddress})</td>
  * <td>Bind the {@link Channel} to the specified local address.</td>
  * </tr>
  * <tr>
+ * <td>{@code "unbind"}</td>
  * <td>{@link ChannelStateEvent}<br/>(state = {@link ChannelState#BOUND BOUND}, value = {@code null})</td>
  * <td>Unbind the {@link Channel} from the current local address.</td>
  * </tr>
  * <tr>
+ * <td>{@code "connect"}</td>
  * <td>{@link ChannelStateEvent}<br/>(state = {@link ChannelState#CONNECTED CONNECTED}, value = {@link SocketAddress})</td>
  * <td>Connect the {@link Channel} to the specified remote address.</td>
  * </tr>
  * <tr>
+ * <td>{@code "disconnect"}</td>
  * <td>{@link ChannelStateEvent}<br/>(state = {@link ChannelState#CONNECTED CONNECTED}, value = {@code null})</td>
  * <td>Disconnect the {@link Channel} from the current remote address.</td>
  * </tr>
  * <tr>
+ * <td>{@code "close"}</td>
  * <td>{@link ChannelStateEvent}<br/>(state = {@link ChannelState#OPEN OPEN}, value = {@code false})</td>
  * <td>Close the {@link Channel}.</td>
  * </tr>
  * </table>
  * <p>
  * Other event types and conditions which were not addressed here will be
- * ignored and discarded.
+ * ignored and discarded.  Please note that there's no {@code "open"} in the
+ * table.  It's because a {@link Channel} is always open when it's created
+ * by a {@link ChannelFactory}.
  *
  * <h4>Additional resources worth reading</h4>
  * <p>