io.reactivex.netty.channel.events

Class ConnectionEventPublisher<T extends ConnectionEventListener>

java.lang.Object

io.reactivex.netty.channel.events.ConnectionEventListener

io.reactivex.netty.channel.events.ConnectionEventPublisher<T>

Type Parameters:

T - Type of listener to expect.

All Implemented Interfaces:

EventListener, EventPublisher, EventSource<T>

public final class ConnectionEventPublisher<T extends ConnectionEventListener>
extends ConnectionEventListener
implements EventSource<T>, EventPublisher

A publisher which is both EventSource and EventListener for connection events.

Constructor Summary

Constructors

Constructor and Description
ConnectionEventPublisher()
ConnectionEventPublisher(ConnectionEventPublisher<T> toCopy)

Method Summary

Modifier and Type	Method and Description
ConnectionEventPublisher<T>	copy()
void	onByteRead(long bytesRead) Event whenever any bytes are read on any open connection.
void	onByteWritten(long bytesWritten) Event whenever any bytes are successfully written on any open connection.
void	onConnectionCloseFailed(long duration, java.util.concurrent.TimeUnit timeUnit, java.lang.Throwable throwable) Event whenever a connection close failed.
void	onConnectionCloseStart() Event whenever a close of any connection is issued.
void	onConnectionCloseSuccess(long duration, java.util.concurrent.TimeUnit timeUnit) Event whenever a close of any connection is successful.
void	onCustomEvent(java.lang.Object event) Typically specific instances on EventListener will provide events that are fired by RxNetty, however, there may be cases, where a user would want to emit custom events.
void	onCustomEvent(java.lang.Object event, long duration, java.util.concurrent.TimeUnit timeUnit) Typically specific instances on EventListener will provide events that are fired by RxNetty, however, there may be cases, where a user would want to emit custom events.
void	onCustomEvent(java.lang.Object event, long duration, java.util.concurrent.TimeUnit timeUnit, java.lang.Throwable throwable) Typically specific instances on EventListener will provide events that are fired by RxNetty, however, there may be cases, where a user would want to emit custom events.
void	onCustomEvent(java.lang.Object event, java.lang.Throwable throwable) Typically specific instances on EventListener will provide events that are fired by RxNetty, however, there may be cases, where a user would want to emit custom events.
void	onFlushComplete(long duration, java.util.concurrent.TimeUnit timeUnit) Event whenever flush completes.
void	onFlushStart() Event whenever a flush is issued on a connection.
void	onWriteFailed(long duration, java.util.concurrent.TimeUnit timeUnit, java.lang.Throwable throwable) Event whenever a write failed on a connection.
void	onWriteStart() Event whenever a write is issued on a connection.
void	onWriteSuccess(long duration, java.util.concurrent.TimeUnit timeUnit) Event whenever data is written successfully on a connection.
boolean	publishingEnabled() Returns true if event publishing is enabled.
rx.Subscription	subscribe(T listener) Subscribes the passed listener for events published by this source.

Methods inherited from class io.reactivex.netty.channel.events.ConnectionEventListener

onCompleted

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionEventPublisher

public ConnectionEventPublisher()

ConnectionEventPublisher

public ConnectionEventPublisher(ConnectionEventPublisher<T> toCopy)

Method Detail

onByteRead

public void onByteRead(long bytesRead)

Description copied from class: ConnectionEventListener

Event whenever any bytes are read on any open connection.

Overrides:

onByteRead in class ConnectionEventListener

Parameters:

bytesRead - Number of bytes read.

onByteWritten

public void onByteWritten(long bytesWritten)

Description copied from class: ConnectionEventListener

Event whenever any bytes are successfully written on any open connection.

Overrides:

onByteWritten in class ConnectionEventListener

Parameters:

bytesWritten - Number of bytes written.

onFlushStart

public void onFlushStart()

Description copied from class: ConnectionEventListener

Event whenever a flush is issued on a connection.

Overrides:

onFlushStart in class ConnectionEventListener

onFlushComplete

public void onFlushComplete(long duration,
                            java.util.concurrent.TimeUnit timeUnit)

Description copied from class: ConnectionEventListener

Event whenever flush completes.

Overrides:

onFlushComplete in class ConnectionEventListener

Parameters:

duration - Duration between flush start and completion.

timeUnit - Timeunit for the duration.

onWriteStart

public void onWriteStart()

Description copied from class: ConnectionEventListener

Event whenever a write is issued on a connection.

Overrides:

onWriteStart in class ConnectionEventListener

onWriteSuccess

public void onWriteSuccess(long duration,
                           java.util.concurrent.TimeUnit timeUnit)

Description copied from class: ConnectionEventListener

Event whenever data is written successfully on a connection. Use ConnectionEventListener.onByteWritten(long) to capture number of bytes written.

Overrides:

onWriteSuccess in class ConnectionEventListener

Parameters:

duration - Duration between write start and completion.

timeUnit - Timeunit for the duration.

onWriteFailed

public void onWriteFailed(long duration,
                          java.util.concurrent.TimeUnit timeUnit,
                          java.lang.Throwable throwable)

Description copied from class: ConnectionEventListener

Event whenever a write failed on a connection.

Overrides:

onWriteFailed in class ConnectionEventListener

Parameters:

duration - Duration between write start and failure.

timeUnit - Timeunit for the duration.

throwable - Error that caused the failure..

onConnectionCloseStart

public void onConnectionCloseStart()

Description copied from class: ConnectionEventListener

Event whenever a close of any connection is issued. This event will only be fired when the physical connection is closed and not when a pooled connection is closed and put back in the pool.

Overrides:

onConnectionCloseStart in class ConnectionEventListener

onConnectionCloseSuccess

public void onConnectionCloseSuccess(long duration,
                                     java.util.concurrent.TimeUnit timeUnit)

Description copied from class: ConnectionEventListener

Event whenever a close of any connection is successful.

Overrides:

onConnectionCloseSuccess in class ConnectionEventListener

Parameters:

duration - Duration between close start and completion.

timeUnit - Timeunit for the duration.

onConnectionCloseFailed

public void onConnectionCloseFailed(long duration,
                                    java.util.concurrent.TimeUnit timeUnit,
                                    java.lang.Throwable throwable)

Description copied from class: ConnectionEventListener

Event whenever a connection close failed.

Overrides:

onConnectionCloseFailed in class ConnectionEventListener

Parameters:

duration - Duration between close start and failure.

timeUnit - Timeunit for the duration.

throwable - Error that caused the failure.

onCustomEvent

public void onCustomEvent(java.lang.Object event)

Description copied from interface: EventListener

Typically specific instances on EventListener will provide events that are fired by RxNetty, however, there may be cases, where a user would want to emit custom events. eg: Creating a custom protocol on top of an existing protocol like TCP, would perhaps require some additional events. In such a case, this callback can be utilized.

Specified by:

onCustomEvent in interface EventListener

Overrides:

onCustomEvent in class ConnectionEventListener

Parameters:

event - Event published.

See Also:

EventListener.onCustomEvent(Object, long, TimeUnit), EventListener.onCustomEvent(Object, Throwable), EventListener.onCustomEvent(Object, long, TimeUnit, Throwable)

onCustomEvent

public void onCustomEvent(java.lang.Object event,
                          long duration,
                          java.util.concurrent.TimeUnit timeUnit)

Description copied from interface: EventListener

Typically specific instances on EventListener will provide events that are fired by RxNetty, however, there may be cases, where a user would want to emit custom events. eg: Creating a custom protocol on top of an existing protocol like TCP, would perhaps require some additional events. In such a case, this callback can be utilized. One should use this overload as opposed to EventListener.onCustomEvent(Object) if the custom event need not be created per invocation but has to be associated with a duration. This is a simple optimization to reduce event creation overhead.

Specified by:

onCustomEvent in interface EventListener

Overrides:

onCustomEvent in class ConnectionEventListener

Parameters:

event - Event published.

duration - Duration associated with this event. The semantics of this duration is totally upto the published event.

timeUnit - Timeunit for the duration.

See Also:

EventListener.onCustomEvent(Object, long, TimeUnit), EventListener.onCustomEvent(Object, Throwable), EventListener.onCustomEvent(Object, long, TimeUnit, Throwable)

onCustomEvent

public void onCustomEvent(java.lang.Object event,
                          long duration,
                          java.util.concurrent.TimeUnit timeUnit,
                          java.lang.Throwable throwable)

Description copied from interface: EventListener

Typically specific instances on EventListener will provide events that are fired by RxNetty, however, there may be cases, where a user would want to emit custom events. eg: Creating a custom protocol on top of an existing protocol like TCP, would perhaps require some additional events. In such a case, this callback can be utilized. One should use this overload as opposed to EventListener.onCustomEvent(Object) if the custom event need not be created per invocation but has to be associated with a duration and an error. This is a simple optimization to reduce event creation overhead.

Specified by:

onCustomEvent in interface EventListener

Overrides:

onCustomEvent in class ConnectionEventListener

Parameters:

event - Event published.

duration - Duration associated with this event. The semantics of this duration is totally upto the published event.

timeUnit - Timeunit for the duration.

throwable - Error associated with the event.

See Also:

EventListener.onCustomEvent(Object, long, TimeUnit), EventListener.onCustomEvent(Object, Throwable), EventListener.onCustomEvent(Object, long, TimeUnit, Throwable)

onCustomEvent

public void onCustomEvent(java.lang.Object event,
                          java.lang.Throwable throwable)

Description copied from interface: EventListener

Typically specific instances on EventListener will provide events that are fired by RxNetty, however, there may be cases, where a user would want to emit custom events. eg: Creating a custom protocol on top of an existing protocol like TCP, would perhaps require some additional events. In such a case, this callback can be utilized. One should use this overload as opposed to EventListener.onCustomEvent(Object) if the custom event need not be created per invocation but has to be associated with an error. This is a simple optimization to reduce event creation overhead.

Specified by:

onCustomEvent in interface EventListener

Overrides:

onCustomEvent in class ConnectionEventListener

Parameters:

event - Event published.

See Also:

EventListener.onCustomEvent(Object, long, TimeUnit), EventListener.onCustomEvent(Object, Throwable), EventListener.onCustomEvent(Object, long, TimeUnit, Throwable)

subscribe

public rx.Subscription subscribe(T listener)

Description copied from interface: EventSource

Subscribes the passed listener for events published by this source.

Specified by:

subscribe in interface EventSource<T extends ConnectionEventListener>

Parameters:

listener - Listener for events published by this source.

Returns:

Subscription, from which one can unsubscribe to stop receiving events.

publishingEnabled

public boolean publishingEnabled()

Description copied from interface: EventPublisher

Returns true if event publishing is enabled. This is primarily used to short-circuit event publishing if the publishing is not enabled. Event publishing will be disabled if there are no active listeners or has been explicitly disabled using RxNetty.disableEventPublishing()

Specified by:

publishingEnabled in interface EventPublisher

Returns:

true if event publishing is enabled.

copy

public ConnectionEventPublisher<T> copy()