io.reactivex.netty.events

Interface EventListener

All Known Subinterfaces:

SafeEventListener

All Known Implementing Classes:

ClientEventListener, ConnectionEventListener, ConnectionEventPublisher

public interface EventListener

A listener to subscribe to events published by an EventSource

Method Summary

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

Method Detail

onCompleted

void onCompleted()

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

onCustomEvent

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

Parameters:

event - Event published.

See Also:

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

onCustomEvent

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

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:

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

onCustomEvent

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

Parameters:

event - Event published.

See Also:

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

onCustomEvent

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

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:

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