reactor.netty.http

Class IdleTimeoutHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.netty.handler.timeout.IdleStateHandler

reactor.netty.http.IdleTimeoutHandler

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

public final class IdleTimeoutHandler
extends IdleStateHandler

A handler that manages idle timeout for HTTP connections. This handler will close the connection if it remains idle for the specified duration. It may also check the liveness of the HTTP connection with sending series of ping messages.

Since:

1.2.12

Author:

raccoonback, Violeta Georgieva

Nested Class Summary

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

ChannelHandler.Sharable

Method Summary

Modifier and Type	Method and Description
static void	addIdleTimeoutHandler(ChannelPipeline pipeline, Duration idleTimeout, HttpConnectionLiveness httpConnectionLiveness) Adds an idle timeout handler to the pipeline.
protected void	channelIdle(ChannelHandlerContext ctx, IdleStateEvent evt)
void	channelInactive(ChannelHandlerContext ctx)
void	channelRead(ChannelHandlerContext ctx, Object msg)
void	handlerRemoved(ChannelHandlerContext ctx)
static void	removeIdleTimeoutHandler(ChannelPipeline pipeline) Removes the idle timeout handler from the pipeline if it exists.

Methods inherited from class io.netty.handler.timeout.IdleStateHandler

channelActive, channelReadComplete, channelRegistered, getAllIdleTimeInMillis, getReaderIdleTimeInMillis, getWriterIdleTimeInMillis, handlerAdded, newIdleStateEvent, resetReadTimeout, resetWriteTimeout, write

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

Method Detail

channelIdle

protected void channelIdle(ChannelHandlerContext ctx,
                           IdleStateEvent evt)

Overrides:

channelIdle in class IdleStateHandler

channelRead

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

Specified by:

channelRead in interface ChannelInboundHandler

Overrides:

channelRead in class IdleStateHandler

Throws:

Exception

channelInactive

public void channelInactive(ChannelHandlerContext ctx)
                     throws Exception

Specified by:

channelInactive in interface ChannelInboundHandler

Overrides:

channelInactive in class IdleStateHandler

Throws:

Exception

handlerRemoved

public void handlerRemoved(ChannelHandlerContext ctx)
                    throws Exception

Specified by:

handlerRemoved in interface ChannelHandler

Overrides:

handlerRemoved in class IdleStateHandler

Throws:

Exception

addIdleTimeoutHandler

public static void addIdleTimeoutHandler(ChannelPipeline pipeline,
                                         @Nullable
                                         Duration idleTimeout,
                                         HttpConnectionLiveness httpConnectionLiveness)

Adds an idle timeout handler to the pipeline.

Parameters:

pipeline - the channel pipeline

idleTimeout - the idle timeout duration

httpConnectionLiveness - the HTTP connection liveness checker

Since:

1.2.12

removeIdleTimeoutHandler

public static void removeIdleTimeoutHandler(ChannelPipeline pipeline)

Removes the idle timeout handler from the pipeline if it exists.

Parameters:

pipeline - the channel pipeline from which the handler will be removed

Since:

1.2.12