io.netty.handler.timeout

Class 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

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.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());
 ...
 

See Also:

WriteTimeoutHandler, IdleStateHandler

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
ReadTimeoutHandler(int timeoutSeconds) Creates a new instance.
ReadTimeoutHandler(long timeout, TimeUnit unit) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	channelIdle(io.netty.channel.ChannelHandlerContext ctx, IdleStateEvent evt) Is called when an IdleStateEvent should be fired.
protected void	readTimedOut(io.netty.channel.ChannelHandlerContext ctx) Is called when a read timeout was detected.

Methods inherited from class io.netty.handler.timeout.IdleStateHandler

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

Methods inherited from class io.netty.channel.ChannelDuplexHandler

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

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

exceptionCaught

Constructor Detail

ReadTimeoutHandler

public ReadTimeoutHandler(int timeoutSeconds)

Creates a new instance.

Parameters:

timeoutSeconds - read timeout in seconds

ReadTimeoutHandler

public ReadTimeoutHandler(long timeout,
                          TimeUnit unit)

Creates a new instance.

Parameters:

timeout - read timeout

unit - the TimeUnit of timeout

Method Detail

channelIdle

protected final void channelIdle(io.netty.channel.ChannelHandlerContext ctx,
                                 IdleStateEvent evt)
                          throws Exception

Description copied from class: IdleStateHandler

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

Overrides:

channelIdle in class IdleStateHandler

Throws:

Exception

readTimedOut

protected void readTimedOut(io.netty.channel.ChannelHandlerContext ctx)
                     throws Exception

Is called when a read timeout was detected.

Throws:

Exception