andreacavalli/netty5
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Javadoc

Browse Source
This commit is contained in:
Trustin Lee 2009-06-19 11:40:28 +00:00
parent eaf931ac92
commit 120eeabc79
3 changed files with 18 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/main/java/org/jboss/netty/handler/timeout/IdleStateHandler.java
View File

@ -35,6 +35,7 @@ import org.jboss.netty.channel.MessageEvent;
import org.jboss.netty.channel.SimpleChannelUpstreamHandler; import org.jboss.netty.channel.SimpleChannelUpstreamHandler;
import org.jboss.netty.channel.WriteCompletionEvent; import org.jboss.netty.channel.WriteCompletionEvent;
import org.jboss.netty.util.ExternalResourceReleasable; import org.jboss.netty.util.ExternalResourceReleasable;
import org.jboss.netty.util.HashedWheelTimer;
import org.jboss.netty.util.Timeout; import org.jboss.netty.util.Timeout;
import org.jboss.netty.util.Timer; import org.jboss.netty.util.Timer;
import org.jboss.netty.util.TimerTask; import org.jboss.netty.util.TimerTask;
@ -72,6 +73,7 @@ import org.jboss.netty.util.TimerTask;
* @author Trustin Lee (tlee@redhat.com) * @author Trustin Lee (tlee@redhat.com)
* @version $Rev$, $Date$ * @version $Rev$, $Date$
* *
* @see HashedWheelTimer
* @see ReadTimeoutHandler * @see ReadTimeoutHandler
* @see WriteTimeoutHandler * @see WriteTimeoutHandler
*/ */
@ -100,7 +102,8 @@ public class IdleStateHandler extends SimpleChannelUpstreamHandler
* Creates a new instance. * Creates a new instance.
* *
* @param timer * @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 * @param readerIdleTimeSeconds
* an {@link IdleStateEvent} whose state is {@link IdleState#READER_IDLE} * an {@link IdleStateEvent} whose state is {@link IdleState#READER_IDLE}
* will be triggered when no read was performed for the specified * will be triggered when no read was performed for the specified
@ -129,7 +132,8 @@ public class IdleStateHandler extends SimpleChannelUpstreamHandler
* Creates a new instance. * Creates a new instance.
* *
* @param timer * @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 * @param readerIdleTime
* an {@link IdleStateEvent} whose state is {@link IdleState#READER_IDLE} * an {@link IdleStateEvent} whose state is {@link IdleState#READER_IDLE}
* will be triggered when no read was performed for the specified * will be triggered when no read was performed for the specified

8
src/main/java/org/jboss/netty/handler/timeout/ReadTimeoutHandler.java
View File

@ -34,6 +34,7 @@ import org.jboss.netty.channel.LifeCycleAwareChannelHandler;
import org.jboss.netty.channel.MessageEvent; import org.jboss.netty.channel.MessageEvent;
import org.jboss.netty.channel.SimpleChannelUpstreamHandler; import org.jboss.netty.channel.SimpleChannelUpstreamHandler;
import org.jboss.netty.util.ExternalResourceReleasable; import org.jboss.netty.util.ExternalResourceReleasable;
import org.jboss.netty.util.HashedWheelTimer;
import org.jboss.netty.util.Timeout; import org.jboss.netty.util.Timeout;
import org.jboss.netty.util.Timer; import org.jboss.netty.util.Timer;
import org.jboss.netty.util.TimerTask; import org.jboss.netty.util.TimerTask;
@ -46,6 +47,7 @@ import org.jboss.netty.util.TimerTask;
* @author Trustin Lee (tlee@redhat.com) * @author Trustin Lee (tlee@redhat.com)
* @version $Rev$, $Date$ * @version $Rev$, $Date$
* *
* @see HashedWheelTimer
* @see WriteTimeoutHandler * @see WriteTimeoutHandler
* @see IdleStateHandler * @see IdleStateHandler
*/ */
@ -66,7 +68,8 @@ public class ReadTimeoutHandler extends SimpleChannelUpstreamHandler
* Creates a new instance. * Creates a new instance.
* *
* @param timer * @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 * @param timeoutSeconds
* read timeout in seconds * read timeout in seconds
*/ */
@ -78,7 +81,8 @@ public class ReadTimeoutHandler extends SimpleChannelUpstreamHandler
* Creates a new instance. * Creates a new instance.
* *
* @param timer * @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 * @param timeout
* read timeout * read timeout
* @param unit * @param unit

8
src/main/java/org/jboss/netty/handler/timeout/WriteTimeoutHandler.java
View File

@ -34,6 +34,7 @@ import org.jboss.netty.channel.Channels;
import org.jboss.netty.channel.MessageEvent; import org.jboss.netty.channel.MessageEvent;
import org.jboss.netty.channel.SimpleChannelDownstreamHandler; import org.jboss.netty.channel.SimpleChannelDownstreamHandler;
import org.jboss.netty.util.ExternalResourceReleasable; import org.jboss.netty.util.ExternalResourceReleasable;
import org.jboss.netty.util.HashedWheelTimer;
import org.jboss.netty.util.Timeout; import org.jboss.netty.util.Timeout;
import org.jboss.netty.util.Timer; import org.jboss.netty.util.Timer;
import org.jboss.netty.util.TimerTask; import org.jboss.netty.util.TimerTask;
@ -46,6 +47,7 @@ import org.jboss.netty.util.TimerTask;
* @author Trustin Lee (tlee@redhat.com) * @author Trustin Lee (tlee@redhat.com)
* @version $Rev$, $Date$ * @version $Rev$, $Date$
* *
* @see HashedWheelTimer
* @see ReadTimeoutHandler * @see ReadTimeoutHandler
* @see IdleStateHandler * @see IdleStateHandler
*/ */
@ -62,7 +64,8 @@ public class WriteTimeoutHandler extends SimpleChannelDownstreamHandler
* Creates a new instance. * Creates a new instance.
* *
* @param timer * @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 * @param timeoutSeconds
* write timeout in seconds * write timeout in seconds
*/ */
@ -74,7 +77,8 @@ public class WriteTimeoutHandler extends SimpleChannelDownstreamHandler
* Creates a new instance. * Creates a new instance.
* *
* @param timer * @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 * @param timeout
* write timeout * write timeout
* @param unit * @param unit