io.micronaut.http.client.netty

Class ConnectTTLHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.micronaut.http.client.netty.ConnectTTLHandler

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler

public class ConnectTTLHandler
extends io.netty.channel.ChannelDuplexHandler

A handler that will close channels after they have reached their time-to-live, regardless of usage. channels that are in use will be closed when they are next released to the underlying connection pool.

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
static io.netty.util.AttributeKey<Boolean>	RELEASE_CHANNEL

Constructor Summary

Constructors

Constructor and Description
ConnectTTLHandler(Long connectionTtlMillis) Construct ConnectTTLHandler for given arguments.

Method Summary

Modifier and Type	Method and Description
void	handlerAdded(io.netty.channel.ChannelHandlerContext ctx) Will schedule a task when the handler added.
void	handlerRemoved(io.netty.channel.ChannelHandlerContext ctx) Will cancel the scheduled tasks when handler removed.
static boolean	isChannelExpired(io.netty.channel.Channel channel) Indicates whether the channels connection ttl has expired.

Methods inherited from class io.netty.channel.ChannelDuplexHandler

bind, close, connect, deregister, disconnect, flush, read, write

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelRead, channelReadComplete, channelRegistered, 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

Field Detail

RELEASE_CHANNEL

public static final io.netty.util.AttributeKey<Boolean> RELEASE_CHANNEL

Constructor Detail

ConnectTTLHandler

public ConnectTTLHandler(Long connectionTtlMillis)

Construct ConnectTTLHandler for given arguments.

Parameters:

connectionTtlMillis - The configured connect-ttl

Method Detail

handlerAdded

public void handlerAdded(io.netty.channel.ChannelHandlerContext ctx)
                  throws Exception

Will schedule a task when the handler added.

Specified by:

handlerAdded in interface io.netty.channel.ChannelHandler

Overrides:

handlerAdded in class io.netty.channel.ChannelHandlerAdapter

Parameters:

ctx - The context to use

Throws:

Exception

handlerRemoved

public void handlerRemoved(io.netty.channel.ChannelHandlerContext ctx)

Will cancel the scheduled tasks when handler removed.

Specified by:

handlerRemoved in interface io.netty.channel.ChannelHandler

Overrides:

handlerRemoved in class io.netty.channel.ChannelHandlerAdapter

Parameters:

ctx - The context to use

isChannelExpired

public static boolean isChannelExpired(io.netty.channel.Channel channel)

Indicates whether the channels connection ttl has expired.

Parameters:

channel - The channel to check

Returns:

true if the channels ttl has expired