io.reactivex.netty.pipeline

Class ReadTimeoutPipelineConfigurator

java.lang.Object

io.reactivex.netty.pipeline.ReadTimeoutPipelineConfigurator

All Implemented Interfaces:

PipelineConfigurator<java.lang.Object,java.lang.Object>

@ChannelHandler.Sharable
public class ReadTimeoutPipelineConfigurator
extends java.lang.Object
implements PipelineConfigurator<java.lang.Object,java.lang.Object>

An implementation of PipelineConfigurator to configure a read time handler.
A read timeout is defined as lack of bytes read from the channel over the specified period.
This configurator, adds the ReadTimeoutHandler after every write, if not present.

Reusable connections and timeout

In cases where the connection is reused (like HTTP persistent connections), it is the responsibility of the protocol to remove this timeout handler, for not being timed out (resulting in connection close) due to inactivity when the connection is not in use.

See Also:

ReadTimeoutHandler

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	READ_TIMEOUT_HANDLER_NAME
static java.lang.String	READ_TIMEOUT_LIFECYCLE_MANAGER_HANDLER_NAME

Constructor Summary

Constructors

Constructor and Description
ReadTimeoutPipelineConfigurator(long timeout, java.util.concurrent.TimeUnit timeUnit)

Method Summary

Methods

Modifier and Type	Method and Description
void	configureNewPipeline(io.netty.channel.ChannelPipeline pipeline) A callback to configure the passed pipeline.
static void	disableReadTimeout(io.netty.channel.ChannelPipeline pipeline)

Methods inherited from class java.lang.Object

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

Field Detail

READ_TIMEOUT_HANDLER_NAME

public static final java.lang.String READ_TIMEOUT_HANDLER_NAME

See Also:

Constant Field Values

READ_TIMEOUT_LIFECYCLE_MANAGER_HANDLER_NAME

public static final java.lang.String READ_TIMEOUT_LIFECYCLE_MANAGER_HANDLER_NAME

See Also:

Constant Field Values

Constructor Detail

ReadTimeoutPipelineConfigurator

public ReadTimeoutPipelineConfigurator(long timeout,
                               java.util.concurrent.TimeUnit timeUnit)

Method Detail

configureNewPipeline

public void configureNewPipeline(io.netty.channel.ChannelPipeline pipeline)

Description copied from interface: PipelineConfigurator

A callback to configure the passed pipeline. This will be invoked everytime a new netty pipeline is created, which is whenever a new channel is established.

Specified by:

configureNewPipeline in interface PipelineConfigurator<java.lang.Object,java.lang.Object>

Parameters:

pipeline - The pipeline to configure.

disableReadTimeout

public static void disableReadTimeout(io.netty.channel.ChannelPipeline pipeline)