org.jboss.netty.handler.timeout

类 ReadTimeoutHandler

java.lang.Object

org.jboss.netty.channel.SimpleChannelUpstreamHandler

org.jboss.netty.handler.timeout.ReadTimeoutHandler

所有已实现的接口:

ChannelHandler, ChannelUpstreamHandler, LifeCycleAwareChannelHandler, ExternalResourceReleasable

@ChannelHandler.Sharable
public class ReadTimeoutHandler
extends SimpleChannelUpstreamHandler
implements LifeCycleAwareChannelHandler, ExternalResourceReleasable

Raises a ReadTimeoutException when no data was read within a certain period of time.

 public class MyPipelineFactory implements ChannelPipelineFactory {

     private final Timer timer;
     private final ChannelHandler timeoutHandler;

     public MyPipelineFactory(Timer timer) {
         this.timer = timer;
         this.timeoutHandler = new ReadTimeoutHandler(timer, 30), // timer must be shared.
     }

     public ChannelPipeline getPipeline() {
         // An example configuration that implements 30-second read timeout:
         return Channels.pipeline(
             timeoutHandler,
             new MyHandler());
     }
 }

 ServerBootstrap bootstrap = ...;
 Timer timer = new HashedWheelTimer();
 ...
 bootstrap.setPipelineFactory(new MyPipelineFactory(timer));
 ...
 

The Timer which was specified when the ReadTimeoutHandler is created should be stopped manually by calling releaseExternalResources() or Timer.stop() when your application shuts down.

另请参阅:

WriteTimeoutHandler, IdleStateHandler

嵌套类概要

从接口继承的嵌套类/接口 org.jboss.netty.channel.ChannelHandler

ChannelHandler.Sharable

构造器概要

构造器

构造器和说明
ReadTimeoutHandler(Timer timer, int timeoutSeconds) Creates a new instance.
ReadTimeoutHandler(Timer timer, long timeout, java.util.concurrent.TimeUnit unit) Creates a new instance.

方法概要

方法

限定符和类型	方法和说明
void	afterAdd(ChannelHandlerContext ctx)
void	afterRemove(ChannelHandlerContext ctx)
void	beforeAdd(ChannelHandlerContext ctx)
void	beforeRemove(ChannelHandlerContext ctx)
void	channelClosed(ChannelHandlerContext ctx, ChannelStateEvent e) Invoked when a Channel was closed and all its related resources were released.
void	channelOpen(ChannelHandlerContext ctx, ChannelStateEvent e) Invoked when a Channel is open, but not bound nor connected.
void	messageReceived(ChannelHandlerContext ctx, MessageEvent e) Invoked when a message object (e.g: ChannelBuffer) was received from a remote peer.
protected void	readTimedOut(ChannelHandlerContext ctx)
void	releaseExternalResources() Stops the Timer which was specified in the constructor of this handler.

从类继承的方法 org.jboss.netty.channel.SimpleChannelUpstreamHandler

channelBound, channelConnected, channelDisconnected, channelInterestChanged, channelUnbound, childChannelClosed, childChannelOpen, exceptionCaught, handleUpstream, writeComplete

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ReadTimeoutHandler

public ReadTimeoutHandler(Timer timer,
                  int timeoutSeconds)

Creates a new instance.

参数:

timer - the Timer that is used to trigger the scheduled event. The recommended Timer implementation is HashedWheelTimer.

timeoutSeconds - read timeout in seconds

ReadTimeoutHandler

public ReadTimeoutHandler(Timer timer,
                  long timeout,
                  java.util.concurrent.TimeUnit unit)

Creates a new instance.

参数:

timer - the Timer that is used to trigger the scheduled event. The recommended Timer implementation is HashedWheelTimer.

timeout - read timeout

unit - the TimeUnit of timeout

方法详细资料

releaseExternalResources

public void releaseExternalResources()

Stops the Timer which was specified in the constructor of this handler. You should not call this method if the Timer is in use by other objects.

指定者:

releaseExternalResources 在接口中 ExternalResourceReleasable

beforeAdd

public void beforeAdd(ChannelHandlerContext ctx)
               throws java.lang.Exception

指定者:

beforeAdd 在接口中 LifeCycleAwareChannelHandler

抛出:

java.lang.Exception

afterAdd

public void afterAdd(ChannelHandlerContext ctx)
              throws java.lang.Exception

指定者:

afterAdd 在接口中 LifeCycleAwareChannelHandler

抛出:

java.lang.Exception

beforeRemove

public void beforeRemove(ChannelHandlerContext ctx)
                  throws java.lang.Exception

指定者:

beforeRemove 在接口中 LifeCycleAwareChannelHandler

抛出:

java.lang.Exception

afterRemove

public void afterRemove(ChannelHandlerContext ctx)
                 throws java.lang.Exception

指定者:

afterRemove 在接口中 LifeCycleAwareChannelHandler

抛出:

java.lang.Exception

channelOpen

public void channelOpen(ChannelHandlerContext ctx,
               ChannelStateEvent e)
                 throws java.lang.Exception

从类复制的说明: SimpleChannelUpstreamHandler

Invoked when a Channel is open, but not bound nor connected.
Be aware that this event is fired from within the I/O thread. You should never execute any heavy operation in there as it will block the dispatching to other workers!

覆盖:

channelOpen 在类中 SimpleChannelUpstreamHandler

抛出:

java.lang.Exception

channelClosed

public void channelClosed(ChannelHandlerContext ctx,
                 ChannelStateEvent e)
                   throws java.lang.Exception

从类复制的说明: SimpleChannelUpstreamHandler

Invoked when a Channel was closed and all its related resources were released.

覆盖:

channelClosed 在类中 SimpleChannelUpstreamHandler

抛出:

java.lang.Exception

messageReceived

public void messageReceived(ChannelHandlerContext ctx,
                   MessageEvent e)
                     throws java.lang.Exception

从类复制的说明: SimpleChannelUpstreamHandler

Invoked when a message object (e.g: ChannelBuffer) was received from a remote peer.

覆盖:

messageReceived 在类中 SimpleChannelUpstreamHandler

抛出:

java.lang.Exception

readTimedOut

protected void readTimedOut(ChannelHandlerContext ctx)
                     throws java.lang.Exception

抛出:

java.lang.Exception