io.netty.handler.timeout

Class WriteTimeoutHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.handler.timeout.WriteTimeoutHandler

All Implemented Interfaces:

ChannelHandler, ChannelOutboundHandler

public class WriteTimeoutHandler
extends ChannelOutboundHandlerAdapter

Raises a WriteTimeoutException when a write operation cannot finish in a certain period of time.

 // The connection is closed when a write operation cannot finish in 30 seconds.

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

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

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

See Also:

ReadTimeoutHandler, IdleStateHandler

Nested Class Summary

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

ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
WriteTimeoutHandler(int timeoutSeconds) Creates a new instance.
WriteTimeoutHandler(long timeout, java.util.concurrent.TimeUnit unit) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	handlerRemoved(ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.
void	write(ChannelHandlerContext ctx, java.lang.Object msg, ChannelPromise promise) Calls ChannelHandlerContext.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
protected void	writeTimedOut(ChannelHandlerContext ctx) Is called when a write timeout was detected

Methods inherited from class io.netty.channel.ChannelOutboundHandlerAdapter

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

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, exceptionCaught, handlerAdded, 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, handlerAdded

Constructor Detail

WriteTimeoutHandler

public WriteTimeoutHandler(int timeoutSeconds)

Creates a new instance.

Parameters:

timeoutSeconds - write timeout in seconds

WriteTimeoutHandler

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

Creates a new instance.

Parameters:

timeout - write timeout

unit - the TimeUnit of timeout

Method Detail

write

public void write(ChannelHandlerContext ctx,
                  java.lang.Object msg,
                  ChannelPromise promise)
           throws java.lang.Exception

Description copied from class: ChannelOutboundHandlerAdapter

Calls ChannelHandlerContext.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

write in interface ChannelOutboundHandler

Overrides:

write in class ChannelOutboundHandlerAdapter

Parameters:

ctx - the ChannelHandlerContext for which the write operation is made

msg - the message to write

promise - the ChannelPromise to notify once the operation completes

Throws:

java.lang.Exception - thrown if an error occurs

handlerRemoved

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

Description copied from class: ChannelHandlerAdapter

Do nothing by default, sub-classes may override this method.

Specified by:

handlerRemoved in interface ChannelHandler

Overrides:

handlerRemoved in class ChannelHandlerAdapter

Throws:

java.lang.Exception

writeTimedOut

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

Is called when a write timeout was detected

Throws:

java.lang.Exception