io.netty.handler.timeout

类 WriteTimeoutHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.handler.timeout.WriteTimeoutHandler

所有已实现的接口:

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());
 ...
 

另请参阅:

ReadTimeoutHandler, IdleStateHandler

嵌套类概要

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

ChannelHandler.Sharable

构造器概要

构造器

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

方法概要

限定符和类型	方法和说明
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 ChannelOutboundInvoker.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

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

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

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

ensureNotSharable, exceptionCaught, handlerAdded, isSharable

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

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

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

exceptionCaught, handlerAdded

构造器详细资料

WriteTimeoutHandler

public WriteTimeoutHandler(int timeoutSeconds)

Creates a new instance.

参数:

timeoutSeconds - write timeout in seconds

WriteTimeoutHandler

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

Creates a new instance.

参数:

timeout - write timeout

unit - the TimeUnit of timeout

方法详细资料

write

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

从类复制的说明: ChannelOutboundHandlerAdapter

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

指定者:

write 在接口中 ChannelOutboundHandler

覆盖:

write 在类中 ChannelOutboundHandlerAdapter

参数:

ctx - the ChannelHandlerContext for which the write operation is made

msg - the message to write

promise - the ChannelPromise to notify once the operation completes

抛出:

java.lang.Exception - thrown if an error occurs

handlerRemoved

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

从类复制的说明: ChannelHandlerAdapter

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

指定者:

handlerRemoved 在接口中 ChannelHandler

覆盖:

handlerRemoved 在类中 ChannelHandlerAdapter

抛出:

java.lang.Exception

writeTimedOut

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

Is called when a write timeout was detected

抛出:

java.lang.Exception