Module io.netty5.handler

Package io.netty5.handler.timeout

Class IdleStateHandler

java.lang.Object

io.netty5.handler.timeout.IdleStateHandler

All Implemented Interfaces:

ChannelHandler

Direct Known Subclasses:

ReadTimeoutHandler

public class IdleStateHandler
extends Object
implements ChannelHandler

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

See Also:

ReadTimeoutHandler, WriteTimeoutHandler

Constructor Summary

Constructors

Constructor	Description
IdleStateHandler(int readerIdleTimeSeconds, int writerIdleTimeSeconds, int allIdleTimeSeconds)	Creates a new instance firing IdleStateEvents.
IdleStateHandler(long readerIdleTime, long writerIdleTime, long allIdleTime, TimeUnit unit)	Creates a new instance firing IdleStateEvents.

Method Summary

Modifier and Type	Method	Description
void	channelActive(ChannelHandlerContext ctx)	The Channel of the ChannelHandlerContext is now active
protected void	channelIdle(ChannelHandlerContext ctx, IdleStateEvent evt)	Is called when an IdleStateEvent should be fired.
void	channelInactive(ChannelHandlerContext ctx)	The Channel of the ChannelHandlerContext was registered is now inactive and reached its end of lifetime.
void	channelRead(ChannelHandlerContext ctx, Object msg)	Invoked when the current Channel has read a message from the peer.
void	channelReadComplete(ChannelHandlerContext ctx)	Invoked when the last message read by the current read operation has been consumed by ChannelHandler.channelRead(ChannelHandlerContext, Object).
void	channelRegistered(ChannelHandlerContext ctx)	The Channel of the ChannelHandlerContext was registered with its EventLoop
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)	Gets called after the ChannelHandler was added to the actual context and it's ready to handle events.
void	handlerRemoved(ChannelHandlerContext ctx)	Gets called after the ChannelHandler was removed from the actual context and it doesn't handle events anymore.
protected IdleStateEvent	newIdleStateEvent(IdleState state, boolean first)	Returns a IdleStateEvent.
Future<Void>	write(ChannelHandlerContext ctx, Object msg)	Called once a write operation is made.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty5.channel.ChannelHandler

bind, channelExceptionCaught, channelInboundEvent, channelShutdown, channelUnregistered, channelWritabilityChanged, close, connect, deregister, disconnect, flush, isSharable, pendingOutboundBytes, read, register, sendOutboundEvent, shutdown

Constructor Detail

IdleStateHandler

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

Creates a new instance firing IdleStateEvents.

Parameters:

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,
                        TimeUnit unit)

Creates a new instance firing IdleStateEvents.

Parameters:

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

Method Detail

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 Exception

Description copied from interface: ChannelHandler

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

Specified by:

handlerAdded in interface ChannelHandler

Throws:

Exception

handlerRemoved

public void handlerRemoved(ChannelHandlerContext ctx)
                    throws Exception

Description copied from interface: ChannelHandler

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

Specified by:

handlerRemoved in interface ChannelHandler

Throws:

Exception

channelRegistered

public void channelRegistered(ChannelHandlerContext ctx)
                       throws Exception

Description copied from interface: ChannelHandler

The Channel of the ChannelHandlerContext was registered with its EventLoop

Specified by:

channelRegistered in interface ChannelHandler

Throws:

Exception

channelActive

public void channelActive(ChannelHandlerContext ctx)
                   throws Exception

Description copied from interface: ChannelHandler

The Channel of the ChannelHandlerContext is now active

Specified by:

channelActive in interface ChannelHandler

Throws:

Exception

channelInactive

public void channelInactive(ChannelHandlerContext ctx)
                     throws Exception

Description copied from interface: ChannelHandler

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

Specified by:

channelInactive in interface ChannelHandler

Throws:

Exception

channelRead

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

Description copied from interface: ChannelHandler

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

Specified by:

channelRead in interface ChannelHandler

Throws:

Exception

channelReadComplete

public void channelReadComplete(ChannelHandlerContext ctx)
                         throws Exception

Description copied from interface: ChannelHandler

Invoked when the last message read by the current read operation has been consumed by ChannelHandler.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 ChannelHandlerContext.read() is called.

Specified by:

channelReadComplete in interface ChannelHandler

Throws:

Exception

write

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

Description copied from interface: ChannelHandler

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.

Specified by:

write in interface ChannelHandler

Parameters:

ctx - the ChannelHandlerContext for which the write operation is made

msg - the message to write

Returns:

the Future which will be notified once the operation completes.

channelIdle

protected void channelIdle(ChannelHandlerContext ctx,
                           IdleStateEvent evt)
                    throws Exception

Is called when an IdleStateEvent should be fired. This implementation calls ChannelHandlerContext.fireChannelInboundEvent(Object).

Throws:

Exception

newIdleStateEvent

protected IdleStateEvent newIdleStateEvent(IdleState state,
                                           boolean first)

Returns a IdleStateEvent.