io.reactivex.netty.channel

Class Connection<R,W>

java.lang.Object

io.reactivex.netty.channel.Connection<R,W>

Type Parameters:

R - Type of object that is read from this connection.

W - Type of object that is written to this connection.

All Implemented Interfaces:

ChannelOperations<W>

Direct Known Subclasses:

ConnectionImpl, PooledConnection

public abstract class Connection<R,W>
extends java.lang.Object
implements ChannelOperations<W>

An abstraction over netty's channel providing Rx APIs.

Reading data

Unless, ChannelOption.AUTO_READ is set to true on the underneath channel, data will be read from the connection if and only if there is a subscription to the input stream returned by getInput(). In case, the input data is not required to be consumed, one should call ignoreInput(), otherwise, data will never be read from the channel.

Field Summary

Fields

Modifier and Type	Field and Description
static io.netty.util.AttributeKey<Connection>	CONNECTION_ATTRIBUTE_KEY
protected MarkAwarePipeline	markAwarePipeline

Fields inherited from interface io.reactivex.netty.channel.ChannelOperations

FLUSH_ON_EACH_BYTES, FLUSH_ON_EACH_FILE_REGION, FLUSH_ON_EACH_STRING, FLUSH_ONLY_ON_READ_COMPLETE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Connection(io.netty.channel.Channel nettyChannel)
protected	Connection(Connection<?,?> toCopy, ContentSource<R> contentSource)
protected	Connection(Connection<R,W> toCopy)

Method Summary

Modifier and Type	Method and Description
abstract <RR,WW> Connection<RR,WW>	addChannelHandlerAfter(io.netty.util.concurrent.EventExecutorGroup group, java.lang.String baseName, java.lang.String name, io.netty.channel.ChannelHandler handler) Adds a ChannelHandler to ChannelPipeline for this connection.
abstract <RR,WW> Connection<RR,WW>	addChannelHandlerAfter(java.lang.String baseName, java.lang.String name, io.netty.channel.ChannelHandler handler) Adds a ChannelHandler to ChannelPipeline for this connection.
abstract <RR,WW> Connection<RR,WW>	addChannelHandlerBefore(io.netty.util.concurrent.EventExecutorGroup group, java.lang.String baseName, java.lang.String name, io.netty.channel.ChannelHandler handler) Adds a ChannelHandler to ChannelPipeline for this connection.
abstract <RR,WW> Connection<RR,WW>	addChannelHandlerBefore(java.lang.String baseName, java.lang.String name, io.netty.channel.ChannelHandler handler) Adds a ChannelHandler to ChannelPipeline for this connection.
abstract <RR,WW> Connection<RR,WW>	addChannelHandlerFirst(io.netty.util.concurrent.EventExecutorGroup group, java.lang.String name, io.netty.channel.ChannelHandler handler) Adds a ChannelHandler to ChannelPipeline for this connection.
abstract <RR,WW> Connection<RR,WW>	addChannelHandlerFirst(java.lang.String name, io.netty.channel.ChannelHandler handler) Adds a ChannelHandler to ChannelPipeline for this connection.
abstract <RR,WW> Connection<RR,WW>	addChannelHandlerLast(io.netty.util.concurrent.EventExecutorGroup group, java.lang.String name, io.netty.channel.ChannelHandler handler) Adds a ChannelHandler to ChannelPipeline for this connection.
abstract <RR,WW> Connection<RR,WW>	addChannelHandlerLast(java.lang.String name, io.netty.channel.ChannelHandler handler) Adds a ChannelHandler to ChannelPipeline for this connection.
protected void	connectCloseToChannelClose()
io.netty.channel.ChannelPipeline	getChannelPipeline() Returns the ChannelPipeline for this connection.
ContentSource<R>	getInput() Returns a stream of data that is read from the connection.
MarkAwarePipeline	getResettableChannelPipeline() Returns the MarkAwarePipeline for this connection, changes to which can be reverted at any point in time.
rx.Observable<java.lang.Void>	ignoreInput() Ignores all input on this connection.
abstract <RR,WW> Connection<RR,WW>	pipelineConfigurator(rx.functions.Action1<io.netty.channel.ChannelPipeline> pipelineConfigurator) Configures the ChannelPipeline for this channel, using the passed pipelineConfigurator.
abstract <RR> Connection<RR,W>	transformRead(rx.Observable.Transformer<R,RR> transformer) Transforms this connection's input stream using the passed transformer to create a new Connection instance.
abstract <WW> Connection<R,WW>	transformWrite(AllocatingTransformer<WW,W> transformer) Transforms this connection to enable writing a different object type.
io.netty.channel.Channel	unsafeNettyChannel() Returns the underlying netty Channel for this connection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.reactivex.netty.channel.ChannelOperations

close, close, closeListener, closeNow, flush, write, write, writeAndFlushOnEach, writeBytes, writeBytes, writeBytesAndFlushOnEach, writeFileRegion, writeFileRegion, writeFileRegionAndFlushOnEach, writeString, writeString, writeStringAndFlushOnEach

Field Detail

CONNECTION_ATTRIBUTE_KEY

public static final io.netty.util.AttributeKey<Connection> CONNECTION_ATTRIBUTE_KEY

markAwarePipeline

protected final MarkAwarePipeline markAwarePipeline

Constructor Detail

Connection

protected Connection(io.netty.channel.Channel nettyChannel)

Connection

protected Connection(Connection<R,W> toCopy)

Connection

protected Connection(Connection<?,?> toCopy,
                     ContentSource<R> contentSource)

Method Detail

getInput

public ContentSource<R> getInput()

Returns a stream of data that is read from the connection. Unless, ChannelOption.AUTO_READ is set to true, the content will only be read from the underneath channel, if there is a subscriber to the input. In case, input is not required to be read, call ignoreInput()

Returns:

The stream of data that is read from the connection.

ignoreInput

public rx.Observable<java.lang.Void> ignoreInput()

Ignores all input on this connection. Unless, ChannelOption.AUTO_READ is set to true, the content will only be read from the underneath channel, if there is a subscriber to the input. So, upon recieving this connection, either one should call this method or eventually subscribe to the stream returned by getInput()

Returns:

An Observable, subscription to which will discard the input. This Observable will error/complete when the input errors/completes and unsubscription from here will unsubscribe from the content.

addChannelHandlerFirst

public abstract <RR,WW> Connection<RR,WW> addChannelHandlerFirst(java.lang.String name,
                                                                 io.netty.channel.ChannelHandler handler)

Adds a ChannelHandler to ChannelPipeline for this connection. The specified handler is added at the first position of the pipeline as specified by ChannelPipeline.addFirst(String, ChannelHandler) For better flexibility of pipeline modification, the method pipelineConfigurator(Action1) will be more convenient.

Parameters:

name - Name of the handler.

handler - Handler instance to add.

Returns:

this.

addChannelHandlerFirst

public abstract <RR,WW> Connection<RR,WW> addChannelHandlerFirst(io.netty.util.concurrent.EventExecutorGroup group,
                                                                 java.lang.String name,
                                                                 io.netty.channel.ChannelHandler handler)

Adds a ChannelHandler to ChannelPipeline for this connection. The specified handler is added at the first position of the pipeline as specified by ChannelPipeline.addFirst(EventExecutorGroup, String, ChannelHandler) For better flexibility of pipeline modification, the method pipelineConfigurator(Action1) will be more convenient.

Parameters:

group - the EventExecutorGroup which will be used to execute the ChannelHandler methods

name - the name of the handler to append

handler - Handler instance to add.

Returns:

this.

addChannelHandlerLast

public abstract <RR,WW> Connection<RR,WW> addChannelHandlerLast(java.lang.String name,
                                                                io.netty.channel.ChannelHandler handler)

Adds a ChannelHandler to ChannelPipeline for this connection. The specified handler is added at the last position of the pipeline as specified by ChannelPipeline.addLast(String, ChannelHandler) For better flexibility of pipeline modification, the method pipelineConfigurator(Action1) will be more convenient.

Parameters:

name - Name of the handler.

handler - Handler instance to add.

Returns:

this.

addChannelHandlerLast

public abstract <RR,WW> Connection<RR,WW> addChannelHandlerLast(io.netty.util.concurrent.EventExecutorGroup group,
                                                                java.lang.String name,
                                                                io.netty.channel.ChannelHandler handler)

Adds a ChannelHandler to ChannelPipeline for this connection. The specified handler is added at the last position of the pipeline as specified by ChannelPipeline.addLast(EventExecutorGroup, String, ChannelHandler) For better flexibility of pipeline modification, the method pipelineConfigurator(Action1) will be more convenient.

Parameters:

group - the EventExecutorGroup which will be used to execute the ChannelHandler methods

name - the name of the handler to append

handler - Handler instance to add.

Returns:

this.

addChannelHandlerBefore

public abstract <RR,WW> Connection<RR,WW> addChannelHandlerBefore(java.lang.String baseName,
                                                                  java.lang.String name,
                                                                  io.netty.channel.ChannelHandler handler)

Adds a ChannelHandler to ChannelPipeline for this connection. The specified handler is added before an existing handler with the passed baseName in the pipeline as specified by ChannelPipeline.addBefore(String, String, ChannelHandler) For better flexibility of pipeline modification, the method pipelineConfigurator(Action1) will be more convenient.

Parameters:

baseName - the name of the existing handler

name - Name of the handler.

handler - Handler instance to add.

Returns:

this.

addChannelHandlerBefore

public abstract <RR,WW> Connection<RR,WW> addChannelHandlerBefore(io.netty.util.concurrent.EventExecutorGroup group,
                                                                  java.lang.String baseName,
                                                                  java.lang.String name,
                                                                  io.netty.channel.ChannelHandler handler)

Adds a ChannelHandler to ChannelPipeline for this connection. The specified handler is added before an existing handler with the passed baseName in the pipeline as specified by ChannelPipeline.addBefore(EventExecutorGroup, String, String, ChannelHandler) For better flexibility of pipeline modification, the method pipelineConfigurator(Action1) will be more convenient.

Parameters:

group - the EventExecutorGroup which will be used to execute the ChannelHandler methods

baseName - the name of the existing handler

name - the name of the handler to append

handler - Handler instance to add.

Returns:

this.

addChannelHandlerAfter

public abstract <RR,WW> Connection<RR,WW> addChannelHandlerAfter(java.lang.String baseName,
                                                                 java.lang.String name,
                                                                 io.netty.channel.ChannelHandler handler)

Adds a ChannelHandler to ChannelPipeline for this connection. The specified handler is added after an existing handler with the passed baseName in the pipeline as specified by ChannelPipeline.addAfter(String, String, ChannelHandler) For better flexibility of pipeline modification, the method pipelineConfigurator(Action1) will be more convenient.

Parameters:

baseName - the name of the existing handler

name - Name of the handler.

handler - Handler instance to add.

Returns:

this.

addChannelHandlerAfter

public abstract <RR,WW> Connection<RR,WW> addChannelHandlerAfter(io.netty.util.concurrent.EventExecutorGroup group,
                                                                 java.lang.String baseName,
                                                                 java.lang.String name,
                                                                 io.netty.channel.ChannelHandler handler)

Adds a ChannelHandler to ChannelPipeline for this connection. The specified handler is added after an existing handler with the passed baseName in the pipeline as specified by ChannelPipeline.addAfter(EventExecutorGroup, String, String, ChannelHandler) For better flexibility of pipeline modification, the method pipelineConfigurator(Action1) will be more convenient.

Parameters:

group - the EventExecutorGroup which will be used to execute the ChannelHandler methods

baseName - the name of the existing handler

name - the name of the handler to append

handler - Handler instance to add.

Returns:

this.

pipelineConfigurator

public abstract <RR,WW> Connection<RR,WW> pipelineConfigurator(rx.functions.Action1<io.netty.channel.ChannelPipeline> pipelineConfigurator)

Configures the ChannelPipeline for this channel, using the passed pipelineConfigurator.

Parameters:

pipelineConfigurator - Action to configure ChannelPipeline.

Returns:

this.

transformRead

public abstract <RR> Connection<RR,W> transformRead(rx.Observable.Transformer<R,RR> transformer)

Transforms this connection's input stream using the passed transformer to create a new Connection instance.

Type Parameters:

RR - New type of the input stream.

Parameters:

transformer - Transformer to transform the input stream.

Returns:

A new connection instance with the transformed read stream.

transformWrite

public abstract <WW> Connection<R,WW> transformWrite(AllocatingTransformer<WW,W> transformer)

Transforms this connection to enable writing a different object type.

Specified by:

transformWrite in interface ChannelOperations<W>

Type Parameters:

WW - New object types to be written to the connection.

Parameters:

transformer - Transformer to transform objects written to the channel.

Returns:

A new connection instance with the new write type.

getResettableChannelPipeline

public MarkAwarePipeline getResettableChannelPipeline()

Returns the MarkAwarePipeline for this connection, changes to which can be reverted at any point in time.

getChannelPipeline

public io.netty.channel.ChannelPipeline getChannelPipeline()

Returns the ChannelPipeline for this connection.

Returns:

ChannelPipeline for this connection.

unsafeNettyChannel

public io.netty.channel.Channel unsafeNettyChannel()

Returns the underlying netty Channel for this connection.

Why unsafe?

It is advisable to use this connection abstraction for all interactions with the channel, however, advanced users may find directly using the netty channel useful in some cases.

Returns:

The underlying netty Channel for this connection.

connectCloseToChannelClose

protected void connectCloseToChannelClose()