From b3f9f91f6a2026df2c937b0815b2abb24656f409 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Br=C3=A9gier?= Date: Fri, 20 Mar 2009 18:04:42 +0000 Subject: [PATCH] Fix doc --- .../org/jboss/netty/handler/trafficshaping/package-info.java | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/main/java/org/jboss/netty/handler/trafficshaping/package-info.java b/src/main/java/org/jboss/netty/handler/trafficshaping/package-info.java index 8386f80721..5cc5619df5 100644 --- a/src/main/java/org/jboss/netty/handler/trafficshaping/package-info.java +++ b/src/main/java/org/jboss/netty/handler/trafficshaping/package-info.java @@ -51,7 +51,8 @@ * sometimes it will block for a while which can turn to "timeout" operations. * For instance, let says that you've got 2 NioWorkers, and 10 clients wants to send data to your server. If you set a bandwidth limitation * of 100KB/s for each channel (client), you could have a final limitation of about 60KB/s for each channel since NioWorkers are - * stopping by this handler.

+ * stopping by this handler.
+ * When it is used as a read traffic shaper, the handler will set the channel as not readable, so as to relax the NioWorkers.

* The method getMessageSize(MessageEvent) has to be implemented to specify what is the size of the object to be read or write * accordingly to the type of object. In simple case, it can be as simple as a call to getChannelBufferMessageSize(MessageEvent).
*