From 120eeabc79aa14377b64a71d6c06ddf78723661b Mon Sep 17 00:00:00 2001 From: Trustin Lee Date: Fri, 19 Jun 2009 11:40:28 +0000 Subject: [PATCH] Javadoc --- .../org/jboss/netty/handler/timeout/IdleStateHandler.java | 8 ++++++-- .../jboss/netty/handler/timeout/ReadTimeoutHandler.java | 8 ++++++-- .../jboss/netty/handler/timeout/WriteTimeoutHandler.java | 8 ++++++-- 3 files changed, 18 insertions(+), 6 deletions(-) diff --git a/src/main/java/org/jboss/netty/handler/timeout/IdleStateHandler.java b/src/main/java/org/jboss/netty/handler/timeout/IdleStateHandler.java index 88dd1cb72d..6e8e7feef8 100644 --- a/src/main/java/org/jboss/netty/handler/timeout/IdleStateHandler.java +++ b/src/main/java/org/jboss/netty/handler/timeout/IdleStateHandler.java @@ -35,6 +35,7 @@ import org.jboss.netty.channel.MessageEvent; import org.jboss.netty.channel.SimpleChannelUpstreamHandler; import org.jboss.netty.channel.WriteCompletionEvent; import org.jboss.netty.util.ExternalResourceReleasable; +import org.jboss.netty.util.HashedWheelTimer; import org.jboss.netty.util.Timeout; import org.jboss.netty.util.Timer; import org.jboss.netty.util.TimerTask; @@ -72,6 +73,7 @@ import org.jboss.netty.util.TimerTask; * @author Trustin Lee (tlee@redhat.com) * @version $Rev$, $Date$ * + * @see HashedWheelTimer * @see ReadTimeoutHandler * @see WriteTimeoutHandler */ @@ -100,7 +102,8 @@ public class IdleStateHandler extends SimpleChannelUpstreamHandler * Creates a new instance. * * @param timer - * the {@link Timer} that is used to trigger the scheduled event + * the {@link Timer} that is used to trigger the scheduled event. + * The recommended {@link Timer} implementation is {@link HashedWheelTimer}. * @param readerIdleTimeSeconds * an {@link IdleStateEvent} whose state is {@link IdleState#READER_IDLE} * will be triggered when no read was performed for the specified @@ -129,7 +132,8 @@ public class IdleStateHandler extends SimpleChannelUpstreamHandler * Creates a new instance. * * @param timer - * the {@link Timer} that is used to trigger the scheduled event + * the {@link Timer} that is used to trigger the scheduled event. + * The recommended {@link Timer} implementation is {@link HashedWheelTimer}. * @param readerIdleTime * an {@link IdleStateEvent} whose state is {@link IdleState#READER_IDLE} * will be triggered when no read was performed for the specified diff --git a/src/main/java/org/jboss/netty/handler/timeout/ReadTimeoutHandler.java b/src/main/java/org/jboss/netty/handler/timeout/ReadTimeoutHandler.java index 18220b0263..7e6a7eebb8 100644 --- a/src/main/java/org/jboss/netty/handler/timeout/ReadTimeoutHandler.java +++ b/src/main/java/org/jboss/netty/handler/timeout/ReadTimeoutHandler.java @@ -34,6 +34,7 @@ import org.jboss.netty.channel.LifeCycleAwareChannelHandler; import org.jboss.netty.channel.MessageEvent; import org.jboss.netty.channel.SimpleChannelUpstreamHandler; import org.jboss.netty.util.ExternalResourceReleasable; +import org.jboss.netty.util.HashedWheelTimer; import org.jboss.netty.util.Timeout; import org.jboss.netty.util.Timer; import org.jboss.netty.util.TimerTask; @@ -46,6 +47,7 @@ import org.jboss.netty.util.TimerTask; * @author Trustin Lee (tlee@redhat.com) * @version $Rev$, $Date$ * + * @see HashedWheelTimer * @see WriteTimeoutHandler * @see IdleStateHandler */ @@ -66,7 +68,8 @@ public class ReadTimeoutHandler extends SimpleChannelUpstreamHandler * Creates a new instance. * * @param timer - * the {@link Timer} that is used to trigger the scheduled event + * the {@link Timer} that is used to trigger the scheduled event. + * The recommended {@link Timer} implementation is {@link HashedWheelTimer}. * @param timeoutSeconds * read timeout in seconds */ @@ -78,7 +81,8 @@ public class ReadTimeoutHandler extends SimpleChannelUpstreamHandler * Creates a new instance. * * @param timer - * the {@link Timer} that is used to trigger the scheduled event + * the {@link Timer} that is used to trigger the scheduled event. + * The recommended {@link Timer} implementation is {@link HashedWheelTimer}. * @param timeout * read timeout * @param unit diff --git a/src/main/java/org/jboss/netty/handler/timeout/WriteTimeoutHandler.java b/src/main/java/org/jboss/netty/handler/timeout/WriteTimeoutHandler.java index 53bf0fde72..edd8479230 100644 --- a/src/main/java/org/jboss/netty/handler/timeout/WriteTimeoutHandler.java +++ b/src/main/java/org/jboss/netty/handler/timeout/WriteTimeoutHandler.java @@ -34,6 +34,7 @@ import org.jboss.netty.channel.Channels; import org.jboss.netty.channel.MessageEvent; import org.jboss.netty.channel.SimpleChannelDownstreamHandler; import org.jboss.netty.util.ExternalResourceReleasable; +import org.jboss.netty.util.HashedWheelTimer; import org.jboss.netty.util.Timeout; import org.jboss.netty.util.Timer; import org.jboss.netty.util.TimerTask; @@ -46,6 +47,7 @@ import org.jboss.netty.util.TimerTask; * @author Trustin Lee (tlee@redhat.com) * @version $Rev$, $Date$ * + * @see HashedWheelTimer * @see ReadTimeoutHandler * @see IdleStateHandler */ @@ -62,7 +64,8 @@ public class WriteTimeoutHandler extends SimpleChannelDownstreamHandler * Creates a new instance. * * @param timer - * the {@link Timer} that is used to trigger the scheduled event + * the {@link Timer} that is used to trigger the scheduled event. + * The recommended {@link Timer} implementation is {@link HashedWheelTimer}. * @param timeoutSeconds * write timeout in seconds */ @@ -74,7 +77,8 @@ public class WriteTimeoutHandler extends SimpleChannelDownstreamHandler * Creates a new instance. * * @param timer - * the {@link Timer} that is used to trigger the scheduled event + * the {@link Timer} that is used to trigger the scheduled event. + * The recommended {@link Timer} implementation is {@link HashedWheelTimer}. * @param timeout * write timeout * @param unit