io.reactivex.netty.events

Class ListenersHolder<T extends EventListener>

java.lang.Object

io.reactivex.netty.events.ListenersHolder<T>

Type Parameters:

T - Type of listener to store.

All Implemented Interfaces:

EventPublisher, EventSource<T>

public final class ListenersHolder<T extends EventListener>
extends java.lang.Object
implements EventSource<T>, EventPublisher

A holder for storing EventListener providing utility methods for any EventSource implementation that requires storing and invoking listeners.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ListenersHolder<T>	copy()
void	dispose()
void	invokeListeners(rx.functions.Action1<T> invocationAction) Invoke listeners with an action expressed by the passed invocationAction.
<A> void	invokeListeners(rx.functions.Action2<T,A> invocationAction, A arg) Invoke listeners with an action expressed by the passed invocationAction.
void	invokeListeners(rx.functions.Action3<T,java.lang.Long,java.util.concurrent.TimeUnit> invocationAction, long duration, java.util.concurrent.TimeUnit timeUnit) Invoke listeners with an action expressed by the passed invocationAction.
<A> void	invokeListeners(rx.functions.Action3<T,java.lang.Throwable,A> invocationAction, java.lang.Throwable throwable, A arg) Invoke listeners with an action expressed by the passed invocationAction.
<A> void	invokeListeners(rx.functions.Action4<T,java.lang.Long,java.util.concurrent.TimeUnit,A> invocationAction, long duration, java.util.concurrent.TimeUnit timeUnit, A arg) Invoke listeners with an action expressed by the passed invocationAction.
void	invokeListeners(rx.functions.Action4<T,java.lang.Long,java.util.concurrent.TimeUnit,java.lang.Throwable> invocationAction, long duration, java.util.concurrent.TimeUnit timeUnit, java.lang.Throwable throwable) Invoke listeners with an action expressed by the passed invocationAction.
<A> void	invokeListeners(rx.functions.Action5<T,java.lang.Long,java.util.concurrent.TimeUnit,java.lang.Throwable,A> invocationAction, long duration, java.util.concurrent.TimeUnit timeUnit, java.lang.Throwable throwable, A arg) Invoke listeners with an action expressed by the passed invocationAction.
boolean	publishingEnabled() Returns true if event publishing is enabled.
rx.Subscription	subscribe(T listener) Subscribes the passed listener for events published by this source.
void	subscribeAllTo(EventSource<T> lazySource)

Methods inherited from class java.lang.Object

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

Constructor Detail

ListenersHolder

public ListenersHolder()

ListenersHolder

public ListenersHolder(ListenersHolder<T> toCopy)

Method Detail

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

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.

dispose

public void dispose()

invokeListeners

public void invokeListeners(rx.functions.Action1<T> invocationAction)

Invoke listeners with an action expressed by the passed invocationAction. This method does the necessary validations required for invoking a listener and also guards against a listener throwing exceptions on invocation.

Parameters:

invocationAction - The action to perform on all listeners.

invokeListeners

public void invokeListeners(rx.functions.Action3<T,java.lang.Long,java.util.concurrent.TimeUnit> invocationAction,
                            long duration,
                            java.util.concurrent.TimeUnit timeUnit)

Invoke listeners with an action expressed by the passed invocationAction. This method does the necessary validations required for invoking a listener and also guards against a listener throwing exceptions on invocation.

Parameters:

invocationAction - The action to perform on all listeners.

duration - Duration.

timeUnit - Time unit for the duration.

invokeListeners

public void invokeListeners(rx.functions.Action4<T,java.lang.Long,java.util.concurrent.TimeUnit,java.lang.Throwable> invocationAction,
                            long duration,
                            java.util.concurrent.TimeUnit timeUnit,
                            java.lang.Throwable throwable)

Invoke listeners with an action expressed by the passed invocationAction. This method does the necessary validations required for invoking a listener and also guards against a listener throwing exceptions on invocation.

Parameters:

invocationAction - The action to perform on all listeners.

duration - Duration.

timeUnit - Time unit for the duration.

throwable - An error.

invokeListeners

public <A> void invokeListeners(rx.functions.Action4<T,java.lang.Long,java.util.concurrent.TimeUnit,A> invocationAction,
                                long duration,
                                java.util.concurrent.TimeUnit timeUnit,
                                A arg)

Invoke listeners with an action expressed by the passed invocationAction. This method does the necessary validations required for invoking a listener and also guards against a listener throwing exceptions on invocation.

Parameters:

invocationAction - The action to perform on all listeners.

duration - Duration.

timeUnit - Time unit for the duration.

arg - Any arbitrary argument

invokeListeners

public <A> void invokeListeners(rx.functions.Action5<T,java.lang.Long,java.util.concurrent.TimeUnit,java.lang.Throwable,A> invocationAction,
                                long duration,
                                java.util.concurrent.TimeUnit timeUnit,
                                java.lang.Throwable throwable,
                                A arg)

Invoke listeners with an action expressed by the passed invocationAction. This method does the necessary validations required for invoking a listener and also guards against a listener throwing exceptions on invocation.

Parameters:

invocationAction - The action to perform on all listeners.

duration - Duration.

timeUnit - Time unit for the duration.

throwable - An error.

arg - Any arbitrary argument

invokeListeners

public <A> void invokeListeners(rx.functions.Action2<T,A> invocationAction,
                                A arg)

Invoke listeners with an action expressed by the passed invocationAction. This method does the necessary validations required for invoking a listener and also guards against a listener throwing exceptions on invocation.

Parameters:

invocationAction - The action to perform on all listeners.

arg - Any arbitrary argument

invokeListeners

public <A> void invokeListeners(rx.functions.Action3<T,java.lang.Throwable,A> invocationAction,
                                java.lang.Throwable throwable,
                                A arg)

Invoke listeners with an action expressed by the passed invocationAction. This method does the necessary validations required for invoking a listener and also guards against a listener throwing exceptions on invocation.

Parameters:

invocationAction - The action to perform on all listeners.

throwable - An error.

arg - Any arbitrary argument

copy

public ListenersHolder<T> copy()

subscribeAllTo

public void subscribeAllTo(EventSource<T> lazySource)