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 implements ChannelHandler {
    @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());
...

Nested and Inner Type Summary

Modifier and Type	Class and Description
private abstract static class	IdleStateHandler.AbstractIdleTask
private class	IdleStateHandler.AllIdleTimeoutTask
private class	IdleStateHandler.ReaderIdleTimeoutTask
private class	IdleStateHandler.WriterIdleTimeoutTask

Field Summary

Modifier and Type	Field and Description
private final long	allIdleTimeNanos
private Future<?>	allIdleTimeout
private boolean	firstAllIdleEvent
private boolean	firstReaderIdleEvent
private boolean	firstWriterIdleEvent
private long	lastReadTime
private long	lastWriteTime
private static final long	MIN_TIMEOUT_NANOS
private final long	readerIdleTimeNanos
private Future<?>	readerIdleTimeout
private boolean	reading
private byte	state
private final FutureListener<Void>	writeListener
private final long	writerIdleTimeNanos
private Future<?>	writerIdleTimeout

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	IdleStateHandler(int 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. readerIdleTimeSeconds, int 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. writerIdleTimeSeconds, int 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. allIdleTimeSeconds) Creates a new instance firing `IdleStateEvent`s.
public	IdleStateHandler(long 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. readerIdleTime, long 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. writerIdleTime, long 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. allIdleTime, TimeUnit the `TimeUnit` of `readerIdleTime`, `writeIdleTime`, and `allIdleTime` unit) Creates a new instance firing `IdleStateEvent`s.

public

IdleStateHandler(int

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.

readerIdleTimeSeconds, int

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.

writerIdleTimeSeconds, int

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.

allIdleTimeSeconds)

Creates a new instance firing IdleStateEvents.

public

IdleStateHandler(long

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.

readerIdleTime, long

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.

writerIdleTime, long

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.

allIdleTime, TimeUnit

the TimeUnit of readerIdleTime, writeIdleTime, and allIdleTime

unit)

Creates a new instance firing IdleStateEvents.

Method Summary

Modifier and Type	Method and Description
public void	channelActive(ChannelHandlerContext ctx) Overrides default io.netty5.channel.ChannelHandler.channelActive. The `Channel` of the `ChannelHandlerContext` is now active
protected void	channelIdle(ChannelHandlerContext ctx, IdleStateEvent evt) Is called when an `IdleStateEvent` should be fired.
public void	channelInactive(ChannelHandlerContext ctx) Overrides default io.netty5.channel.ChannelHandler.channelInactive. The `Channel` of the `ChannelHandlerContext` was registered is now inactive and reached its end of lifetime.
public void	channelRead(ChannelHandlerContext ctx, Object msg) Overrides default io.netty5.channel.ChannelHandler.channelRead. Invoked when the current `Channel` has read a message from the peer.
public void	channelReadComplete(ChannelHandlerContext ctx) Overrides default io.netty5.channel.ChannelHandler.channelReadComplete. Invoked when the last message read by the current read operation has been consumed by `channelRead(ChannelHandlerContext, Object)`.
public void	channelRegistered(ChannelHandlerContext ctx) Overrides default io.netty5.channel.ChannelHandler.channelRegistered. The `Channel` of the `ChannelHandlerContext` was registered with its `EventLoop`
private void	destroy()
public long	getAllIdleTimeInMillis() Return the allIdleTime that was given when instance this class in milliseconds.
public long	getReaderIdleTimeInMillis() Return the readerIdleTime that was given when instance this class in milliseconds.
public long	getWriterIdleTimeInMillis() Return the writerIdleTime that was given when instance this class in milliseconds.
public void	handlerAdded(ChannelHandlerContext ctx) Overrides default io.netty5.channel.ChannelHandler.handlerAdded. Gets called after the `ChannelHandler` was added to the actual context and it's ready to handle events.
public void	handlerRemoved(ChannelHandlerContext ctx) Overrides default io.netty5.channel.ChannelHandler.handlerRemoved. Gets called after the `ChannelHandler` was removed from the actual context and it doesn't handle events anymore.
private void	initialize(ChannelHandlerContext ctx)
protected IdleStateEvent	newIdleStateEvent(IdleState state, boolean first) Returns a `IdleStateEvent`.
pack-priv Future<?>	schedule(ChannelHandlerContext ctx, Runnable task, long delay, TimeUnit unit) This method is visible for testing!
pack-priv long	ticksInNanos() This method is visible for testing!
public Future<Void>	write(ChannelHandlerContext the `ChannelHandlerContext` for which the write operation is made ctx, Object the message to write msg) Overrides default io.netty5.channel.ChannelHandler.write. Called once a write operation is made.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

allIdleTimeNanos	back to summary
private final long allIdleTimeNanos

allIdleTimeout	back to summary
private Future<?> allIdleTimeout

firstAllIdleEvent	back to summary
private boolean firstAllIdleEvent

firstReaderIdleEvent	back to summary
private boolean firstReaderIdleEvent

firstWriterIdleEvent	back to summary
private boolean firstWriterIdleEvent

lastReadTime	back to summary
private long lastReadTime

lastWriteTime	back to summary
private long lastWriteTime

MIN_TIMEOUT_NANOS	back to summary
private static final long MIN_TIMEOUT_NANOS

readerIdleTimeNanos	back to summary
private final long readerIdleTimeNanos

readerIdleTimeout	back to summary
private Future<?> readerIdleTimeout

reading	back to summary
private boolean reading

state	back to summary
private byte state

writeListener	back to summary
private final FutureListener<Void> writeListener

writerIdleTimeNanos	back to summary
private final long writerIdleTimeNanos

writerIdleTimeout	back to summary
private Future<?> writerIdleTimeout

Constructor Detail

IdleStateHandler back to summary

IdleStateHandler	back to summary
public IdleStateHandler(int readerIdleTimeSeconds, int writerIdleTimeSeconds, int allIdleTimeSeconds) Creates a new instance firing `IdleStateEvent`s. Parameters readerIdleTimeSeconds:int 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:int 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:int 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.

public IdleStateHandler(int readerIdleTimeSeconds, int writerIdleTimeSeconds, int allIdleTimeSeconds)

Creates a new instance firing IdleStateEvents.

Parameters

readerIdleTimeSeconds:int: 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:int: 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:int: 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 back to summary

IdleStateHandler	back to summary
public IdleStateHandler(long readerIdleTime, long writerIdleTime, long allIdleTime, TimeUnit unit) Creates a new instance firing `IdleStateEvent`s. Parameters readerIdleTime:long 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:long 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:long 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:TimeUnit the `TimeUnit` of `readerIdleTime`, `writeIdleTime`, and `allIdleTime`

public IdleStateHandler(long readerIdleTime, long writerIdleTime, long allIdleTime, TimeUnit unit)

Creates a new instance firing IdleStateEvents.

Parameters

readerIdleTime:long: 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:long: 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:long: 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:TimeUnit: the TimeUnit of readerIdleTime, writeIdleTime, and allIdleTime

Method Detail

channelActive back to summary

channelActive	back to summary
public void channelActive(ChannelHandlerContext ctx) throws Exception Overrides default io.netty5.channel.ChannelHandler.channelActive. Doc from io.netty5.channel.ChannelHandler.channelActive. The `Channel` of the `ChannelHandlerContext` is now active Annotations @Override

public void channelActive(ChannelHandlerContext ctx) throws Exception

Overrides default io.netty5.channel.ChannelHandler.channelActive.

Doc from io.netty5.channel.ChannelHandler.channelActive.

The Channel of the ChannelHandlerContext is now active

Annotations

@Override

channelIdle	back to summary
protected void channelIdle(ChannelHandlerContext ctx, IdleStateEvent evt) throws Exception Is called when an `IdleStateEvent` should be fired. This implementation calls `ChannelHandlerContext#fireChannelInboundEvent(Object)`.

channelInactive back to summary

channelInactive	back to summary
public void channelInactive(ChannelHandlerContext ctx) throws Exception Overrides default io.netty5.channel.ChannelHandler.channelInactive. Doc from io.netty5.channel.ChannelHandler.channelInactive. The `Channel` of the `ChannelHandlerContext` was registered is now inactive and reached its end of lifetime. Annotations @Override

public void channelInactive(ChannelHandlerContext ctx) throws Exception

Overrides default io.netty5.channel.ChannelHandler.channelInactive.

Doc from io.netty5.channel.ChannelHandler.channelInactive.

The Channel of the ChannelHandlerContext was registered is now inactive and reached its end of lifetime.

Annotations

@Override

channelRead back to summary

channelRead	back to summary
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception Overrides default io.netty5.channel.ChannelHandler.channelRead. Doc from io.netty5.channel.ChannelHandler.channelRead. Invoked when the current `Channel` has read a message from the peer. Annotations @Override

public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception

Overrides default io.netty5.channel.ChannelHandler.channelRead.

Doc from io.netty5.channel.ChannelHandler.channelRead.

Invoked when the current Channel has read a message from the peer.

Annotations

@Override

channelReadComplete back to summary

channelReadComplete	back to summary
public void channelReadComplete(ChannelHandlerContext ctx) throws Exception Overrides default io.netty5.channel.ChannelHandler.channelReadComplete. Doc from io.netty5.channel.ChannelHandler.channelReadComplete. Invoked when the last message read by the current read operation has been consumed by `channelRead(ChannelHandlerContext, Object)`. If `ChannelOption#AUTO_READ` is off, no further attempt to read an inbound data from the current `Channel` will be made until `ChannelOutboundInvoker#read(ReadBufferAllocator)` is called. Annotations @Override

public void channelReadComplete(ChannelHandlerContext ctx) throws Exception

Overrides default io.netty5.channel.ChannelHandler.channelReadComplete.

Doc from io.netty5.channel.ChannelHandler.channelReadComplete.

Invoked when the last message read by the current read operation has been consumed by channelRead(ChannelHandlerContext, Object). If ChannelOption#AUTO_READ is off, no further attempt to read an inbound data from the current Channel will be made until ChannelOutboundInvoker#read(ReadBufferAllocator) is called.

Annotations

@Override

channelRegistered back to summary

channelRegistered	back to summary
public void channelRegistered(ChannelHandlerContext ctx) throws Exception Overrides default io.netty5.channel.ChannelHandler.channelRegistered. Doc from io.netty5.channel.ChannelHandler.channelRegistered. The `Channel` of the `ChannelHandlerContext` was registered with its `EventLoop` Annotations @Override

public void channelRegistered(ChannelHandlerContext ctx) throws Exception

Overrides default io.netty5.channel.ChannelHandler.channelRegistered.

Doc from io.netty5.channel.ChannelHandler.channelRegistered.

The Channel of the ChannelHandlerContext was registered with its EventLoop

Annotations

@Override

destroy	back to summary
private void destroy()

getAllIdleTimeInMillis	back to summary
public long getAllIdleTimeInMillis() Return the allIdleTime that was given when instance this class in milliseconds.

getReaderIdleTimeInMillis	back to summary
public long getReaderIdleTimeInMillis() Return the readerIdleTime that was given when instance this class in milliseconds.

getWriterIdleTimeInMillis	back to summary
public long getWriterIdleTimeInMillis() Return the writerIdleTime that was given when instance this class in milliseconds.

handlerAdded back to summary

handlerAdded	back to summary
public void handlerAdded(ChannelHandlerContext ctx) throws Exception Overrides default io.netty5.channel.ChannelHandler.handlerAdded. Doc from io.netty5.channel.ChannelHandler.handlerAdded. Gets called after the `ChannelHandler` was added to the actual context and it's ready to handle events. Annotations @Override

public void handlerAdded(ChannelHandlerContext ctx) throws Exception

Overrides default io.netty5.channel.ChannelHandler.handlerAdded.

Doc from io.netty5.channel.ChannelHandler.handlerAdded.

Gets called after the ChannelHandler was added to the actual context and it's ready to handle events.

Annotations

@Override

handlerRemoved back to summary

handlerRemoved	back to summary
public void handlerRemoved(ChannelHandlerContext ctx) throws Exception Overrides default io.netty5.channel.ChannelHandler.handlerRemoved. Doc from io.netty5.channel.ChannelHandler.handlerRemoved. Gets called after the `ChannelHandler` was removed from the actual context and it doesn't handle events anymore. Annotations @Override

public void handlerRemoved(ChannelHandlerContext ctx) throws Exception

Overrides default io.netty5.channel.ChannelHandler.handlerRemoved.

Doc from io.netty5.channel.ChannelHandler.handlerRemoved.

Gets called after the ChannelHandler was removed from the actual context and it doesn't handle events anymore.

Annotations

@Override

initialize	back to summary
private void initialize(ChannelHandlerContext ctx)

newIdleStateEvent	back to summary
protected IdleStateEvent newIdleStateEvent(IdleState state, boolean first) Returns a `IdleStateEvent`.

schedule	back to summary
pack-priv Future<?> schedule(ChannelHandlerContext ctx, Runnable task, long delay, TimeUnit unit) This method is visible for testing!

ticksInNanos	back to summary
pack-priv long ticksInNanos() This method is visible for testing!

write back to summary

write	back to summary
public Future<Void> write(ChannelHandlerContext ctx, Object msg) Overrides default io.netty5.channel.ChannelHandler.write. Doc from io.netty5.channel.ChannelHandler.write. Called once a write operation is made. The write operation will write the messages through the `ChannelPipeline`. Those are then ready to be flushed to the actual `Channel` once `Channel#flush()` is called. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` for which the write operation is made msg:Object the message to write Returns:Future<Void> the `Future` which will be notified once the operation completes. Annotations @Override

public Future<Void> write(ChannelHandlerContext ctx, Object msg)

Overrides default io.netty5.channel.ChannelHandler.write.

Doc from io.netty5.channel.ChannelHandler.write.

Called once a write operation is made. The write operation will write the messages through the ChannelPipeline. Those are then ready to be flushed to the actual Channel once Channel#flush() is called.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext for which the write operation is made
msg:Object: the message to write

Returns:Future<Void>

the Future which will be notified once the operation completes.

Annotations

@Override

io.netty5.handler.timeout back to summary

private abstract Class IdleStateHandler.AbstractIdleTask

Class Inheritance

extends Object
implements Runnable

java.lang.Object
io.netty5.handler.timeout.IdleStateHandler.AbstractIdleTask

All Implemented Interfaces

java.lang.Runnable

Known Direct Subclasses

io.netty5.handler.timeout.IdleStateHandler.ReaderIdleTimeoutTask, io.netty5.handler.timeout.IdleStateHandler.WriterIdleTimeoutTask, io.netty5.handler.timeout.IdleStateHandler.AllIdleTimeoutTask

Field Summary

Modifier and Type	Field and Description
private final ChannelHandlerContext	ctx

Constructor Summary

Access	Constructor and Description
pack-priv	AbstractIdleTask(ChannelHandlerContext ctx)

Method Summary

Modifier and Type	Method and Description
public void	run() Implements java.lang.Runnable.run. Runs this operation.
protected abstract void	run(ChannelHandlerContext ctx)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ctx	back to summary
private final ChannelHandlerContext ctx

Constructor Detail

AbstractIdleTask	back to summary
pack-priv AbstractIdleTask(ChannelHandlerContext ctx)

Method Detail

run	back to summary
public void run() Implements java.lang.Runnable.run. Doc from java.lang.Runnable.run. Runs this operation. Annotations @Override

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

Annotations

@Override

run	back to summary
protected abstract void run(ChannelHandlerContext ctx)

public Class IdleStateHandler

Supported idle states

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private abstract Class IdleStateHandler.AbstractIdleTask

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class IdleStateHandler.AllIdleTimeoutTask

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class IdleStateHandler.ReaderIdleTimeoutTask

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class IdleStateHandler.WriterIdleTimeoutTask

Constructor Summary

Method Summary

Constructor Detail

Method Detail