io.reactivex.netty.channel.events

Class ConnectionEventListener

java.lang.Object

io.reactivex.netty.channel.events.ConnectionEventListener

All Implemented Interfaces:

EventListener

Direct Known Subclasses:

ClientEventListener, ConnectionEventPublisher

public abstract class ConnectionEventListener
extends java.lang.Object
implements EventListener

An event listener for all events releated to a Connection

Constructor Summary

Constructors

Constructor and Description
ConnectionEventListener()

Method Summary

Modifier and Type	Method and Description
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	onCompleted() Marks the end of all event callbacks.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionEventListener

public ConnectionEventListener()

Method Detail

onByteRead

public void onByteRead(long bytesRead)

Event whenever any bytes are read on any open connection.

Parameters:

bytesRead - Number of bytes read.

onByteWritten

public void onByteWritten(long bytesWritten)

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

Parameters:

bytesWritten - Number of bytes written.

onFlushStart

public void onFlushStart()

Event whenever a flush is issued on a connection.

onFlushComplete

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

Event whenever flush completes.

Parameters:

duration - Duration between flush start and completion.

timeUnit - Timeunit for the duration.

onWriteStart

public void onWriteStart()

Event whenever a write is issued on a connection.

onWriteSuccess

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

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

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)

Event whenever a write failed on a connection.

Parameters:

duration - Duration between write start and failure.

timeUnit - Timeunit for the duration.

throwable - Error that caused the failure..

onConnectionCloseStart

public void onConnectionCloseStart()

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.

onConnectionCloseSuccess

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

Event whenever a close of any connection is successful.

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)

Event whenever a connection close failed.

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

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

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

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

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)

onCompleted

public void onCompleted()

Description copied from interface: EventListener

Marks the end of all event callbacks. No methods on this listener will ever be called once this method is called.

Specified by:

onCompleted in interface EventListener