io.netty.handler.timeout

类 ReadTimeoutHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.netty.handler.timeout.IdleStateHandler

io.netty.handler.timeout.ReadTimeoutHandler

所有已实现的接口:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

public class ReadTimeoutHandler
extends IdleStateHandler

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

 // The connection is closed when there is no inbound traffic
 // for 30 seconds.

 public class MyChannelInitializer extends ChannelInitializer<Channel> {
     public void initChannel(Channel channel) {
         channel.pipeline().addLast("readTimeoutHandler", new ReadTimeoutHandler(30));
         channel.pipeline().addLast("myHandler", new MyHandler());
     }
 }

 // Handler should handle the ReadTimeoutException.
 public class MyHandler extends ChannelDuplexHandler {
      @Override
     public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause)
             throws Exception {
         if (cause instanceof ReadTimeoutException) {
             // do something
         } else {
             super.exceptionCaught(ctx, cause);
         }
     }
 }

 ServerBootstrap bootstrap = ...;
 ...
 bootstrap.childHandler(new MyChannelInitializer());
 ...
 

另请参阅:

WriteTimeoutHandler, IdleStateHandler

嵌套类概要

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

ChannelHandler.Sharable

构造器概要

构造器

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

方法概要

限定符和类型	方法和说明
protected void	channelIdle(ChannelHandlerContext ctx, IdleStateEvent evt) Is called when an IdleStateEvent should be fired.
protected void	readTimedOut(ChannelHandlerContext ctx) Is called when a read timeout was detected.

从类继承的方法 io.netty.handler.timeout.IdleStateHandler

channelActive, channelInactive, channelRead, channelReadComplete, channelRegistered, getAllIdleTimeInMillis, getReaderIdleTimeInMillis, getWriterIdleTimeInMillis, handlerAdded, handlerRemoved, newIdleStateEvent, resetReadTimeout, resetWriteTimeout, write

从类继承的方法 io.netty.channel.ChannelDuplexHandler

bind, close, connect, deregister, disconnect, flush, read

从类继承的方法 io.netty.channel.ChannelInboundHandlerAdapter

channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

从类继承的方法 io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, isSharable

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

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

从接口继承的方法 io.netty.channel.ChannelHandler

exceptionCaught

构造器详细资料

ReadTimeoutHandler

public ReadTimeoutHandler(int timeoutSeconds)

Creates a new instance.

参数:

timeoutSeconds - read timeout in seconds

ReadTimeoutHandler

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

Creates a new instance.

参数:

timeout - read timeout

unit - the TimeUnit of timeout

方法详细资料

channelIdle

protected final void channelIdle(ChannelHandlerContext ctx,
                                 IdleStateEvent evt)
                          throws java.lang.Exception

从类复制的说明: IdleStateHandler

Is called when an IdleStateEvent should be fired. This implementation calls ChannelHandlerContext.fireUserEventTriggered(Object).

覆盖:

channelIdle 在类中 IdleStateHandler

抛出:

java.lang.Exception

readTimedOut

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

Is called when a read timeout was detected.

抛出:

java.lang.Exception