Package dev.getelements.elements.sdk.util

Class ConcurrentLockedPublisher<T>

java.lang.Object

dev.getelements.elements.sdk.util.ConcurrentLockedPublisher<T>

Type Parameters:

T - the type of event to publish

All Implemented Interfaces:

AsyncPublisher<T>, Publisher<T>, Iterable<Object>

public class ConcurrentLockedPublisher<T>
extends Object
implements AsyncPublisher<T>, Iterable<Object>

Implements a AsyncPublisher using a Lock to control concurrency. For each published event, the supplied Lock will be acquired and then released when all associated Subscriptions have been notified. This implements Iterable for debugging only. This locks and copies the list of Subscriptions to perform the operation.

Constructor Summary

Constructors

Constructor	Description
ConcurrentLockedPublisher(Lock lock)	Creates a new ConcurrentLockedPublisher with the supplied Lock.
ConcurrentLockedPublisher(Lock lock, Consumer<Runnable> dispatch)	Creates a new ConcurrentLockedPublisher with the supplied Lock.

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears all Subscriptions and implicitly removes them from the internal pool.
Iterator<Object>	iterator()
void	publish(T t)	Publishes the event synchronously.
void	publish(T t, Consumer<? super T> onFinish)	Publishes the supplied event synchronously and calls the Consumer when all Subscriptions have been notified.
void	publish(T t, Consumer<? super T> onFinish, Consumer<Throwable> onException)	Publishes the supplied event synchronously and calls the Consumer when all Subscriptions have been notified.
void	publishAsync(T t)	Publishes the supplied event asynchronously.
void	publishAsync(T t, Consumer<T> onFinish)	Publishes the supplied event asynchronously and calls the Consumer<T> when all Subscriptions have been notified.
void	publishAsync(T t, Consumer<T> onFinish, Consumer<Throwable> onException)	Publishes the supplied event asynchronously and calls the Consumer<T> when all Subscriptions have been notified.
Subscription	subscribe(BiConsumer<Subscription,? super T> consumer)	Subscribes to a particular event.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface dev.getelements.elements.sdk.util.Publisher

subscribe

Constructor Details

ConcurrentLockedPublisher

public ConcurrentLockedPublisher(Lock lock)

Creates a new ConcurrentLockedPublisher with the supplied Lock. This uses an internal thread pool to dispatch events to listeners.

Parameters:

lock - the lock to ensure access to this ConcurrentLockedPublisher<T>

ConcurrentLockedPublisher

public ConcurrentLockedPublisher(Lock lock,
 Consumer<Runnable> dispatch)

Creates a new ConcurrentLockedPublisher with the supplied Lock.

Parameters:

lock - the lock to ensure access to this ConcurrentLockedPublisher<T>

dispatch - a Consumer<Runnable> which is used to dispatch tasks

Method Details

subscribe

public Subscription subscribe(BiConsumer<Subscription,? super T> consumer)

Description copied from interface: Publisher

Subscribes to a particular event. The supplied BiConsumer will receive zero or more events in the future until the associated call to Subscription.unsubscribe().

Specified by:

subscribe in interface Publisher<T>

Parameters:

consumer - the BiConsumer which will accept event

Returns:

the Subscription

clear

public void clear()

Description copied from interface: Publisher

Clears all Subscriptions and implicitly removes them from the internal pool. Implementing this interface method is optional, and therefore this may throw an instance of UnsupportedOperationException.

Specified by:

clear in interface Publisher<T>

publish

public void publish(T t)

Description copied from interface: Publisher

Publishes the event synchronously.

Specified by:

publish in interface Publisher<T>

Parameters:

t - the event

publish

public void publish(T t,
 Consumer<? super T> onFinish)

Description copied from interface: Publisher

Publishes the supplied event synchronously and calls the Consumer when all Subscriptions have been notified.

Specified by:

publish in interface Publisher<T>

Parameters:

t - the event

onFinish - the Consumer to be called after all Subscriptions have been notified

publish

public void publish(T t,
 Consumer<? super T> onFinish,
 Consumer<Throwable> onException)

Description copied from interface: Publisher

Publishes the supplied event synchronously and calls the Consumer when all Subscriptions have been notified. Additionally, this notifies for every exception thrown in the process.

Specified by:

publish in interface Publisher<T>

Parameters:

t - the event

onFinish - the Consumer to be called after all Subscriptions have been notified

onException - the Consumer which is notified for each exception thrown

publishAsync

public void publishAsync(T t)

Description copied from interface: AsyncPublisher

Publishes the supplied event asynchronously.

Specified by:

publishAsync in interface AsyncPublisher<T>

Parameters:

t - the event

publishAsync

public void publishAsync(T t,
 Consumer<T> onFinish)

Description copied from interface: AsyncPublisher

Publishes the supplied event asynchronously and calls the Consumer<T> when all Subscriptions have been notified.

Specified by:

publishAsync in interface AsyncPublisher<T>

Parameters:

t - the event

onFinish - the Consumer<T> to be called after all Subscriptions have been notified

publishAsync

public void publishAsync(T t,
 Consumer<T> onFinish,
 Consumer<Throwable> onException)

Description copied from interface: AsyncPublisher

Publishes the supplied event asynchronously and calls the Consumer<T> when all Subscriptions have been notified. Additionally, this notifies for every exception thrown in the process.

Specified by:

publishAsync in interface AsyncPublisher<T>

Parameters:

t - the event

onFinish - the Consumer to be called after all Subscriptions have been notified

onException - the Consumer which is notified for each exception thrown

iterator

public Iterator<Object> iterator()

Specified by:

iterator in interface Iterable<T>