IdleStateHandler (Netty API Reference (4.1.22.Final))

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

All Implemented Interfaces:: ChannelHandler ， ChannelInboundHandler ， ChannelOutboundHandler

已知直接子类：: ReadTimeoutHandler

public class IdleStateHandler
extends ChannelDuplexHandler

Channel 暂时未执行读取，写入操作或两者操作时触发IdleStateEvent 。

支持空闲状态

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 异常 {
         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

Nested Class Summary
- Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler
  ChannelHandler.Sharable

构造方法摘要

构造方法
Constructor and Description
`IdleStateHandler(boolean observeOutput, long readerIdleTime, long writerIdleTime, long allIdleTime, java.util.concurrent.TimeUnit unit)` 创建一个新的实例`IdleStateEvent` 。
`IdleStateHandler(int readerIdleTimeSeconds, int writerIdleTimeSeconds, int allIdleTimeSeconds)` 创建一个新的实例`IdleStateEvent` 。
`IdleStateHandler(long readerIdleTime, long writerIdleTime, long allIdleTime, java.util.concurrent.TimeUnit unit)`

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`void`	`channelActive(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.fireChannelActive()`转发到`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`protected void`	`channelIdle(ChannelHandlerContext ctx, IdleStateEvent evt)` 当应当解雇`IdleStateEvent`时被调用。
`void`	`channelInactive(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.fireChannelInactive()`转发到`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`void`	`channelRead(ChannelHandlerContext ctx, java.lang.Object msg)` 致电`ChannelHandlerContext.fireChannelRead(Object)`转发到`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`void`	`channelReadComplete(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.fireChannelReadComplete()`转发到`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`void`	`channelRegistered(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.fireChannelRegistered()`转发到`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`long`	`getAllIdleTimeInMillis()` 以毫秒为单位返回实例此类时给出的allIdleTime。
`long`	`getReaderIdleTimeInMillis()` 返回实例此类以毫秒为单位给出的readerIdleTime。
`long`	`getWriterIdleTimeInMillis()` 以毫秒为单位返回实例此类的writerIdleTime。
`void`	`handlerAdded(ChannelHandlerContext ctx)` 子类可以忽略这个方法。
`void`	`handlerRemoved(ChannelHandlerContext ctx)` 子类可以忽略这个方法。
`protected IdleStateEvent`	`newIdleStateEvent(IdleState state, boolean first)` 返回`IdleStateEvent` 。
`void`	`write(ChannelHandlerContext ctx, java.lang.Object msg, ChannelPromise promise)` 致电`ChannelOutboundInvoker.write(Object, ChannelPromise)`转发到`ChannelPipeline`中的下一个`ChannelOutboundHandler` 。

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

- 构造方法详细信息
  - IdleStateHandler
```
public IdleStateHandler(int readerIdleTimeSeconds,
                        int writerIdleTimeSeconds,
                        int allIdleTimeSeconds)
```
    创建一个新的实例IdleStateEvent 。
    
    参数
    
    readerIdleTimeSeconds -一个IdleStateEvent ，其状态IdleState.READER_IDLE时的指定时间段没有执行读操作将被触发。指定0禁用。
    
    writerIdleTimeSeconds -一个IdleStateEvent ，其状态IdleState.WRITER_IDLE时的指定时间段没有执行写操作将被触发。指定0禁用。
    
    allIdleTimeSeconds - 当状态为IdleState.ALL_IDLE的状态为IdleState.ALL_IDLE时，将在指定的时间段内未执行读取或写入时触发。指定0禁用。
  - 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)
```
    创建一个新的实例IdleStateEvent 。
    
    参数
    
    observeOutput - 在评估写入闲置时是否应该考虑bytes的消耗。默认值是false 。
    
    readerIdleTime -一个IdleStateEvent ，其状态IdleState.READER_IDLE时的指定时间段没有执行读操作将被触发。指定0禁用。
    
    writerIdleTime -一个IdleStateEvent ，其状态IdleState.WRITER_IDLE时的指定时间段没有执行写操作将被触发。指定0禁用。
    
    allIdleTime - 一个IdleStateEvent的状态为IdleState.ALL_IDLE将在指定的时间段内未执行读取或写入操作时触发。指定0禁用。
    
    unit -在 TimeUnit的 readerIdleTime ， writeIdleTime和 allIdleTime
- 方法详细信息
  - getReaderIdleTimeInMillis
```
public long getReaderIdleTimeInMillis()
```
    返回实例此类以毫秒为单位给出的readerIdleTime。
  - getWriterIdleTimeInMillis
```
public long getWriterIdleTimeInMillis()
```
    以毫秒为单位返回实例此类的writerIdleTime。
  - getAllIdleTimeInMillis
```
public long getAllIdleTimeInMillis()
```
    以毫秒为单位返回实例此类时给出的allIdleTime。
  - handlerAdded
```
public void handlerAdded(ChannelHandlerContext ctx)
                  throws java.lang.Exception
```
    从类复制的描述： ChannelHandlerAdapter
    
    子类可以忽略这个方法。
    
    Specified by:
    
    handlerAdded接口 ChannelHandler
    
    重写：
    
    handlerAdded在课堂上 ChannelHandlerAdapter
    
    异常
    
    java.lang.Exception
  - handlerRemoved
```
public void handlerRemoved(ChannelHandlerContext ctx)
                    throws java.lang.Exception
```
    从类复制的描述： ChannelHandlerAdapter
    
    子类可以忽略这个方法。
    
    Specified by:
    
    handlerRemoved在界面 ChannelHandler
    
    重写：
    
    handlerRemoved在课堂上 ChannelHandlerAdapter
    
    异常
    
    java.lang.Exception
  - channelRegistered
```
public void channelRegistered(ChannelHandlerContext ctx)
                       throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelRegistered()转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelRegistered接口 ChannelInboundHandler
    
    重写：
    
    channelRegistered在课堂上 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - channelActive
```
public void channelActive(ChannelHandlerContext ctx)
                   throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelActive()转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelActive ，界面 ChannelInboundHandler
    
    重写：
    
    channelActive在课堂上 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - channelInactive
```
public void channelInactive(ChannelHandlerContext ctx)
                     throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelInactive()转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelInactive在界面 ChannelInboundHandler
    
    重写：
    
    channelInactive在课堂上 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - channelRead
```
public void channelRead(ChannelHandlerContext ctx,
                        java.lang.Object msg)
                 throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelRead(Object)转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelRead在界面 ChannelInboundHandler
    
    重写：
    
    channelRead在课堂上 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - channelReadComplete
```
public void channelReadComplete(ChannelHandlerContext ctx)
                         throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelReadComplete()转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelReadComplete在界面 ChannelInboundHandler
    
    重写：
    
    channelReadComplete在课堂上 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - write
```
public void write(ChannelHandlerContext ctx,
                  java.lang.Object msg,
                  ChannelPromise promise)
           throws java.lang.Exception
```
    从类复制的描述： ChannelDuplexHandler
    
    致电ChannelOutboundInvoker.write(Object, ChannelPromise)转发到ChannelPipeline中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    write ，界面 ChannelOutboundHandler
    
    重写：
    
    write在课堂上 ChannelDuplexHandler
    
    参数
    
    ctx - 为其写入操作的ChannelHandlerContext
    
    msg - 写信息
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - channelIdle
```
protected void channelIdle(ChannelHandlerContext ctx,
                           IdleStateEvent evt)
                    throws java.lang.Exception
```
    当IdleStateEvent应该被解雇时被调用。这个实现调用ChannelHandlerContext.fireUserEventTriggered(Object) 。
    
    异常
    
    java.lang.Exception
  - newIdleStateEvent
```
protected IdleStateEvent newIdleStateEvent(IdleState state,
                                           boolean first)
```
    Returns a IdleStateEvent.

Class IdleStateHandler

支持空闲状态

Nested Class Summary

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

构造方法摘要

方法摘要

Methods inherited from class io.netty.channel.ChannelDuplexHandler

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.ChannelHandler

构造方法详细信息

IdleStateHandler

IdleStateHandler

IdleStateHandler

方法详细信息

getReaderIdleTimeInMillis

getWriterIdleTimeInMillis

getAllIdleTimeInMillis

handlerAdded

handlerRemoved

channelRegistered

channelActive

channelInactive

channelRead

channelReadComplete

write

channelIdle

newIdleStateEvent