From 320b7133a2c3eb49cec2a1e95c190feeffe49a51 Mon Sep 17 00:00:00 2001
From: Trustin Lee <trustin@gmail.com>
Date: Wed, 24 Sep 2008 10:37:19 +0000
Subject: [PATCH] More clarification on ChannelHandlerContext

---
 .../org/jboss/netty/channel/ChannelHandlerContext.java   | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/main/java/org/jboss/netty/channel/ChannelHandlerContext.java b/src/main/java/org/jboss/netty/channel/ChannelHandlerContext.java
index ebd9c01460..518935638e 100644
--- a/src/main/java/org/jboss/netty/channel/ChannelHandlerContext.java
+++ b/src/main/java/org/jboss/netty/channel/ChannelHandlerContext.java
@@ -25,6 +25,15 @@ package org.jboss.netty.channel;
 /**
  * Provides the properties and operations which are specific to the
  * {@link ChannelHandler} and the {@link ChannelPipeline} it belongs to.
+ * Via a {@link ChannelHandlerContext}, a {@link ChannelHandler} can send
+ * a upstream or downstream {@link ChannelEvent} to the next or previous
+ * {@link ChannelHandler} in the {@link ChannelPipeline}.
+ *
+ * <pre>
+ * +---------+ 1 .. 1 +----------------+ 1 .. n +----------+
+ * | Handler |------->| HandlerContext |------->| Pipeline |
+ * +---------+        +----------------+        +----------+
+ * </pre>
  *
  * @author The Netty Project (netty-dev@lists.jboss.org)
  * @author Trustin Lee (tlee@redhat.com)