io.reactivex.netty.pipeline

Class RxRequiredConfigurator<I,O>

java.lang.Object

io.reactivex.netty.pipeline.RxRequiredConfigurator<I,O>

Type Parameters:

I - Input type for the pipeline. This is the type one writes to this pipeline.

O - Output type of the emitted observable. This is the type one reads from this pipeline.

All Implemented Interfaces:

PipelineConfigurator<I,O>

Direct Known Subclasses:

ClientRequiredConfigurator, ServerRequiredConfigurator

public abstract class RxRequiredConfigurator<I,O>
extends java.lang.Object
implements PipelineConfigurator<I,O>

An implementation of PipelineConfigurator which is ALWAYS added at the end of the pipeline. This pipeline configurator bridges between netty's pipeline processing and Rx Observable

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BYTES_INSPECTOR_HANDLER_NAME
static java.lang.String	CONN_LIFECYCLE_HANDLER_NAME
static java.lang.String	NETTY_OBSERVABLE_ADAPTER_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RxRequiredConfigurator(MetricEventsSubject eventsSubject, ChannelMetricEventProvider metricEventProvider)
protected	RxRequiredConfigurator(MetricEventsSubject eventsSubject, ChannelMetricEventProvider metricEventProvider, io.netty.util.concurrent.EventExecutorGroup handlersExecutorGroup)

Method Summary

Modifier and Type	Method and Description
void	configureNewPipeline(io.netty.channel.ChannelPipeline pipeline) A callback to configure the passed pipeline.
protected io.netty.util.concurrent.EventExecutorGroup	getConnectionLifecycleHandlerExecutor()
protected io.netty.util.concurrent.EventExecutorGroup	getObservableAdapterExecutor()
protected abstract io.netty.channel.ChannelHandler	newConnectionLifecycleHandler(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

CONN_LIFECYCLE_HANDLER_NAME

public static final java.lang.String CONN_LIFECYCLE_HANDLER_NAME

See Also:

Constant Field Values

BYTES_INSPECTOR_HANDLER_NAME

public static final java.lang.String BYTES_INSPECTOR_HANDLER_NAME

See Also:

Constant Field Values

NETTY_OBSERVABLE_ADAPTER_NAME

public static final java.lang.String NETTY_OBSERVABLE_ADAPTER_NAME

See Also:

Constant Field Values

Constructor Detail

RxRequiredConfigurator

protected RxRequiredConfigurator(MetricEventsSubject eventsSubject,
                                 ChannelMetricEventProvider metricEventProvider)

RxRequiredConfigurator

protected RxRequiredConfigurator(MetricEventsSubject eventsSubject,
                                 ChannelMetricEventProvider metricEventProvider,
                                 io.netty.util.concurrent.EventExecutorGroup handlersExecutorGroup)

Parameters:

eventsSubject - Metrics event subject.

metricEventProvider - Metrics event provider.

handlersExecutorGroup - The EventExecutorGroup to be used for all the handlers added by this configurator. This can be null , in which case the eventloop for the underlying channel is used.

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<I,O>

Parameters:

pipeline - The pipeline to configure.

getConnectionLifecycleHandlerExecutor

protected io.netty.util.concurrent.EventExecutorGroup getConnectionLifecycleHandlerExecutor()

getObservableAdapterExecutor

protected io.netty.util.concurrent.EventExecutorGroup getObservableAdapterExecutor()

newConnectionLifecycleHandler

protected abstract io.netty.channel.ChannelHandler newConnectionLifecycleHandler(io.netty.channel.ChannelPipeline pipeline)