IdleStateHandler (Netty 4.1.109.Final API文档

java.lang.Object
- io.netty.channel.ChannelHandlerAdapter
- - io.netty.channel.ChannelInboundHandlerAdapter
  - - io.netty.channel.ChannelDuplexHandler
    - - io.netty.handler.timeout.IdleStateHandler

所有已实现的接口:: ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

直接已知子类:: ReadTimeoutHandler

public class IdleStateHandler
extends ChannelDuplexHandler

Triggers an IdleStateEvent when a Channel has not performed read, write, or both operation for a while.

Supported idle states

Property	Meaning
`readerIdleTime`	an `IdleStateEvent` whose state is `IdleState.READER_IDLE` will be triggered when no read was performed for the specified period of time. Specify `0` to disable.
`writerIdleTime`	an `IdleStateEvent` whose state is `IdleState.WRITER_IDLE` will be triggered when no write was performed for the specified period of time. Specify `0` to disable.
`allIdleTime`	an `IdleStateEvent` whose state is `IdleState.ALL_IDLE` will be triggered when neither read nor write was performed for the specified period of time. Specify `0` to disable.

 // An example that sends a ping message when there is no outbound traffic
 // for 30 seconds.  The connection is closed when there is no inbound traffic
 // for 60 seconds.

 public class MyChannelInitializer extends ChannelInitializer<Channel> {
      @Override
     public void initChannel(Channel channel) {
         channel.pipeline().addLast("idleStateHandler", new IdleStateHandler(60, 30, 0));
         channel.pipeline().addLast("myHandler", new MyHandler());
     }
 }

 // Handler should handle the IdleStateEvent triggered by IdleStateHandler.
 public class MyHandler extends ChannelDuplexHandler {
      @Override
     public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception {
         if (evt instanceof IdleStateEvent) {
             IdleStateEvent e = (IdleStateEvent) evt;
             if (e.state() == IdleState.READER_IDLE) {
                 ctx.close();
             } else if (e.state() == IdleState.WRITER_IDLE) {
                 ctx.writeAndFlush(new PingMessage());
             }
         }
     }
 }

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

另请参阅:: ReadTimeoutHandler, WriteTimeoutHandler

嵌套类概要
- 从接口继承的嵌套类/接口 io.netty.channel.ChannelHandler
  ChannelHandler.Sharable

构造器概要

构造器
构造器和说明
`IdleStateHandler(boolean observeOutput, long readerIdleTime, long writerIdleTime, long allIdleTime, java.util.concurrent.TimeUnit unit)` Creates a new instance firing `IdleStateEvent`s.
`IdleStateHandler(int readerIdleTimeSeconds, int writerIdleTimeSeconds, int allIdleTimeSeconds)` Creates a new instance firing `IdleStateEvent`s.
`IdleStateHandler(long readerIdleTime, long writerIdleTime, long allIdleTime, java.util.concurrent.TimeUnit unit)`

方法概要

All Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`void`	`channelActive(ChannelHandlerContext ctx)` Calls `ChannelHandlerContext.fireChannelActive()` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
`protected void`	`channelIdle(ChannelHandlerContext ctx, IdleStateEvent evt)` Is called when an `IdleStateEvent` should be fired.
`void`	`channelInactive(ChannelHandlerContext ctx)` Calls `ChannelHandlerContext.fireChannelInactive()` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
`void`	`channelRead(ChannelHandlerContext ctx, java.lang.Object msg)` Calls `ChannelHandlerContext.fireChannelRead(Object)` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
`void`	`channelReadComplete(ChannelHandlerContext ctx)` Calls `ChannelHandlerContext.fireChannelReadComplete()` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
`void`	`channelRegistered(ChannelHandlerContext ctx)` Calls `ChannelHandlerContext.fireChannelRegistered()` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
`long`	`getAllIdleTimeInMillis()` Return the allIdleTime that was given when instance this class in milliseconds.
`long`	`getReaderIdleTimeInMillis()` Return the readerIdleTime that was given when instance this class in milliseconds.
`long`	`getWriterIdleTimeInMillis()` Return the writerIdleTime that was given when instance this class in milliseconds.
`void`	`handlerAdded(ChannelHandlerContext ctx)` Do nothing by default, sub-classes may override this method.
`void`	`handlerRemoved(ChannelHandlerContext ctx)` Do nothing by default, sub-classes may override this method.
`protected IdleStateEvent`	`newIdleStateEvent(IdleState state, boolean first)` Returns a `IdleStateEvent`.
`void`	`resetReadTimeout()` Reset the read timeout.
`void`	`resetWriteTimeout()` Reset the write timeout.
`void`	`write(ChannelHandlerContext ctx, java.lang.Object msg, ChannelPromise promise)` Calls `ChannelOutboundInvoker.write(Object, ChannelPromise)` to forward to the next `ChannelOutboundHandler` in the `ChannelPipeline`.

从类继承的方法 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

- 构造器详细资料
  - IdleStateHandler
```
public IdleStateHandler(int readerIdleTimeSeconds,
                        int writerIdleTimeSeconds,
                        int allIdleTimeSeconds)
```
    Creates a new instance firing IdleStateEvents.
    
    参数:
    
    readerIdleTimeSeconds - an IdleStateEvent whose state is IdleState.READER_IDLE will be triggered when no read was performed for the specified period of time. Specify 0 to disable.
    
    writerIdleTimeSeconds - an IdleStateEvent whose state is IdleState.WRITER_IDLE will be triggered when no write was performed for the specified period of time. Specify 0 to disable.
    
    allIdleTimeSeconds - an IdleStateEvent whose state is IdleState.ALL_IDLE will be triggered when neither read nor write was performed for the specified period of time. Specify 0 to disable.
  - IdleStateHandler
```
public IdleStateHandler(long readerIdleTime,
                        long writerIdleTime,
                        long allIdleTime,
                        java.util.concurrent.TimeUnit unit)
```
    另请参阅:
    
    IdleStateHandler(boolean, long, long, long, TimeUnit)
  - IdleStateHandler
```
public IdleStateHandler(boolean observeOutput,
                        long readerIdleTime,
                        long writerIdleTime,
                        long allIdleTime,
                        java.util.concurrent.TimeUnit unit)
```
    Creates a new instance firing IdleStateEvents.
    
    参数:
    
    observeOutput - whether or not the consumption of bytes should be taken into consideration when assessing write idleness. The default is false.
    
    readerIdleTime - an IdleStateEvent whose state is IdleState.READER_IDLE will be triggered when no read was performed for the specified period of time. Specify 0 to disable.
    
    writerIdleTime - an IdleStateEvent whose state is IdleState.WRITER_IDLE will be triggered when no write was performed for the specified period of time. Specify 0 to disable.
    
    allIdleTime - an IdleStateEvent whose state is IdleState.ALL_IDLE will be triggered when neither read nor write was performed for the specified period of time. Specify 0 to disable.
    
    unit - the TimeUnit of readerIdleTime, writeIdleTime, and allIdleTime
- 方法详细资料
  - getReaderIdleTimeInMillis
```
public long getReaderIdleTimeInMillis()
```
    Return the readerIdleTime that was given when instance this class in milliseconds.
  - getWriterIdleTimeInMillis
```
public long getWriterIdleTimeInMillis()
```
    Return the writerIdleTime that was given when instance this class in milliseconds.
  - getAllIdleTimeInMillis
```
public long getAllIdleTimeInMillis()
```
    Return the allIdleTime that was given when instance this class in milliseconds.
  - handlerAdded
```
public void handlerAdded(ChannelHandlerContext ctx)
                  throws java.lang.Exception
```
    从类复制的说明: ChannelHandlerAdapter
    
    Do nothing by default, sub-classes may override this method.
    
    指定者:
    
    handlerAdded 在接口中 ChannelHandler
    
    覆盖:
    
    handlerAdded 在类中 ChannelHandlerAdapter
    
    抛出:
    
    java.lang.Exception
  - 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
  - channelRegistered
```
public void channelRegistered(ChannelHandlerContext ctx)
                       throws java.lang.Exception
```
    从类复制的说明: ChannelInboundHandlerAdapter
    
    Calls ChannelHandlerContext.fireChannelRegistered() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.
    
    指定者:
    
    channelRegistered 在接口中 ChannelInboundHandler
    
    覆盖:
    
    channelRegistered 在类中 ChannelInboundHandlerAdapter
    
    抛出:
    
    java.lang.Exception
  - channelActive
```
public void channelActive(ChannelHandlerContext ctx)
                   throws java.lang.Exception
```
    从类复制的说明: ChannelInboundHandlerAdapter
    
    Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.
    
    指定者:
    
    channelActive 在接口中 ChannelInboundHandler
    
    覆盖:
    
    channelActive 在类中 ChannelInboundHandlerAdapter
    
    抛出:
    
    java.lang.Exception
  - channelInactive
```
public void channelInactive(ChannelHandlerContext ctx)
                     throws java.lang.Exception
```
    从类复制的说明: ChannelInboundHandlerAdapter
    
    Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.
    
    指定者:
    
    channelInactive 在接口中 ChannelInboundHandler
    
    覆盖:
    
    channelInactive 在类中 ChannelInboundHandlerAdapter
    
    抛出:
    
    java.lang.Exception
  - channelRead
```
public void channelRead(ChannelHandlerContext ctx,
                        java.lang.Object msg)
                 throws java.lang.Exception
```
    从类复制的说明: ChannelInboundHandlerAdapter
    
    Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.
    
    指定者:
    
    channelRead 在接口中 ChannelInboundHandler
    
    覆盖:
    
    channelRead 在类中 ChannelInboundHandlerAdapter
    
    抛出:
    
    java.lang.Exception
  - channelReadComplete
```
public void channelReadComplete(ChannelHandlerContext ctx)
                         throws java.lang.Exception
```
    从类复制的说明: ChannelInboundHandlerAdapter
    
    Calls ChannelHandlerContext.fireChannelReadComplete() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.
    
    指定者:
    
    channelReadComplete 在接口中 ChannelInboundHandler
    
    覆盖:
    
    channelReadComplete 在类中 ChannelInboundHandlerAdapter
    
    抛出:
    
    java.lang.Exception
  - write
```
public void write(ChannelHandlerContext ctx,
                  java.lang.Object msg,
                  ChannelPromise promise)
           throws java.lang.Exception
```
    从类复制的说明: ChannelDuplexHandler
    
    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 在类中 ChannelDuplexHandler
    
    参数:
    
    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
  - resetReadTimeout
```
public void resetReadTimeout()
```
    Reset the read timeout. As this handler is not thread-safe, this method must be called on the event loop.
  - resetWriteTimeout
```
public void resetWriteTimeout()
```
    Reset the write timeout. As this handler is not thread-safe, this method must be called on the event loop.
  - channelIdle
```
protected void channelIdle(ChannelHandlerContext ctx,
                           IdleStateEvent evt)
                    throws java.lang.Exception
```
    Is called when an IdleStateEvent should be fired. This implementation calls ChannelHandlerContext.fireUserEventTriggered(Object).
    
    抛出:
    
    java.lang.Exception
  - newIdleStateEvent
```
protected IdleStateEvent newIdleStateEvent(IdleState state,
                                           boolean first)
```
    Returns a IdleStateEvent.

类 IdleStateHandler

Supported idle states

嵌套类概要

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

构造器概要

方法概要

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

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

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

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

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

构造器详细资料

IdleStateHandler

IdleStateHandler

IdleStateHandler

方法详细资料

getReaderIdleTimeInMillis

getWriterIdleTimeInMillis

getAllIdleTimeInMillis

handlerAdded

handlerRemoved

channelRegistered

channelActive

channelInactive

channelRead

channelReadComplete

write

resetReadTimeout

resetWriteTimeout

channelIdle

newIdleStateEvent