io.reactivex.netty.channel

Class SubscriberToChannelFutureBridge

java.lang.Object

io.reactivex.netty.channel.SubscriberToChannelFutureBridge

All Implemented Interfaces:

io.netty.channel.ChannelFutureListener, io.netty.util.concurrent.GenericFutureListener<io.netty.channel.ChannelFuture>, java.util.EventListener

public abstract class SubscriberToChannelFutureBridge
extends java.lang.Object
implements io.netty.channel.ChannelFutureListener

A bridge to connect a Subscriber to a ChannelFuture so that when the subscriber is unsubscribed, the listener will get removed from the future. Failure to do so for futures that are long living, eg: Channel.closeFuture() will lead to a memory leak where the attached listener will be in the listener queue of the future till the channel closes. In order to bridge the future and subscriber, bridge(ChannelFuture, Subscriber) must be called.

Field Summary

Fields inherited from interface io.netty.channel.ChannelFutureListener

CLOSE, CLOSE_ON_FAILURE, FIRE_EXCEPTION_ON_FAILURE

Constructor Summary

Constructors

Constructor and Description
SubscriberToChannelFutureBridge()

Method Summary

Modifier and Type	Method and Description
void	bridge(io.netty.channel.ChannelFuture future, rx.Subscriber<?> subscriber) Bridges the passed subscriber and future, which means the following: Add this listener to the passed future. Add a callback to the subscriber, such that on unsubscribe this listener is removed from the future.
protected abstract void	doOnFailure(io.netty.channel.ChannelFuture future, java.lang.Throwable cause)
protected abstract void	doOnSuccess(io.netty.channel.ChannelFuture future)
void	operationComplete(io.netty.channel.ChannelFuture future)

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriberToChannelFutureBridge

public SubscriberToChannelFutureBridge()

Method Detail

operationComplete

public final void operationComplete(io.netty.channel.ChannelFuture future)
                             throws java.lang.Exception

Specified by:

operationComplete in interface io.netty.util.concurrent.GenericFutureListener<io.netty.channel.ChannelFuture>

Throws:

java.lang.Exception

doOnSuccess

protected abstract void doOnSuccess(io.netty.channel.ChannelFuture future)

doOnFailure

protected abstract void doOnFailure(io.netty.channel.ChannelFuture future,
                                    java.lang.Throwable cause)

bridge

public void bridge(io.netty.channel.ChannelFuture future,
                   rx.Subscriber<?> subscriber)

Bridges the passed subscriber and future, which means the following:

• Add this listener to the passed future.
• Add a callback to the subscriber, such that on unsubscribe this listener is removed from the future.

Parameters:

future - Future to bridge.

subscriber - Subscriber to connect to the future.