org.jboss.netty.handler.timeout

类 WriteTimeoutHandler

java.lang.Object

org.jboss.netty.channel.SimpleChannelDownstreamHandler

org.jboss.netty.handler.timeout.WriteTimeoutHandler

所有已实现的接口:

ChannelDownstreamHandler, ChannelHandler, ExternalResourceReleasable

@ChannelHandler.Sharable
public class WriteTimeoutHandler
extends SimpleChannelDownstreamHandler
implements ExternalResourceReleasable

Raises a WriteTimeoutException when no data was written within a certain period of time.

 public class MyPipelineFactory implements ChannelPipelineFactory {

     private final Timer timer;

     public MyPipelineFactory(Timer timer) {
         this.timer = timer;
     }

     public ChannelPipeline getPipeline() {
         // An example configuration that implements 30-second write timeout:
         return Channels.pipeline(
             new WriteTimeoutHandler(timer, 30), // timer must be shared.
             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.

另请参阅:

ReadTimeoutHandler, IdleStateHandler

嵌套类概要

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

ChannelHandler.Sharable

构造器概要

构造器

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

方法概要

方法

限定符和类型	方法和说明
protected long	getTimeoutMillis(MessageEvent e) Returns the write timeout of the specified event.
void	releaseExternalResources() Stops the Timer which was specified in the constructor of this handler.
void	writeRequested(ChannelHandlerContext ctx, MessageEvent e) Invoked when Channel.write(Object) is called.
protected void	writeTimedOut(ChannelHandlerContext ctx)

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

bindRequested, closeRequested, connectRequested, disconnectRequested, handleDownstream, setInterestOpsRequested, unbindRequested

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

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

构造器详细资料

WriteTimeoutHandler

public WriteTimeoutHandler(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 - write timeout in seconds

WriteTimeoutHandler

public WriteTimeoutHandler(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 - write 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

getTimeoutMillis

protected long getTimeoutMillis(MessageEvent e)

Returns the write timeout of the specified event. By default, this method returns the timeout value you specified in the constructor. Override this method to determine the timeout value depending on the message being written.

参数:

e - the message being written

writeRequested

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

从类复制的说明: SimpleChannelDownstreamHandler

Invoked when Channel.write(Object) is called.

覆盖:

writeRequested 在类中 SimpleChannelDownstreamHandler

抛出:

java.lang.Exception

writeTimedOut

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

抛出:

java.lang.Exception