net.sergeych.tools

Class AsyncEvent<T>

java.lang.Object

net.sergeych.tools.AsyncEvent<T>

Type Parameters:

T - type of the parameter passed to the consumers

public class AsyncEvent<T>
extends java.lang.Object

Asymchronous consumer-based event. Uses cached pool to invoke consumers. All the methods are thread-safe.

Constructor Summary

Constructors

Constructor and Description
AsyncEvent()

Method Summary

Modifier and Type	Method and Description
AsyncEvent<T>	addConsumer(java.util.function.Consumer<T> consumer) Non blocking add consumer to the event.
T	await() Wait until the event is fired.
T	await(long milliseconds) Wait until the event is fired as much as specified number of milliseconds.
void	fire()
void	fire(T result) Fire the event if it was not yet fired.
boolean	isFired()
T	waitFired() Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncEvent

public AsyncEvent()

Method Detail

addConsumer

public AsyncEvent<T> addConsumer(java.util.function.Consumer<T> consumer)

Non blocking add consumer to the event. Returns immediately. If the event is already fired, the consumer will be called immediately and asynchronously (by the pooled thread). Thread safe.

Parameters:

consumer -

Returns:

this instance allowing calls chain

fire

public void fire(T result)

Fire the event if it was not yet fired. Non blocking functions. The consumers are being called in the pooled threads. Does nothing if already fired. Thread-safe.

Parameters:

result - to pass to consumers

isFired

public boolean isFired()

Returns:

true if the event is already fired.

waitFired

@Deprecated
public T waitFired()
                        throws java.lang.InterruptedException

Deprecated.

Wait until the event is fired. If it is already fired, returns immediately the result passed to the fire(Object) call. Same as await()

Returns:

the result passed to the fire(Object)

Throws:

java.lang.InterruptedException

await

public T await()
        throws java.lang.InterruptedException

Wait until the event is fired. If it is already fired, returns immediately the result passed to the fire(Object) call.

Returns:

the result passed to the fire(Object)

Throws:

java.lang.InterruptedException

await

public T await(long milliseconds)
        throws java.util.concurrent.TimeoutException,
               java.lang.InterruptedException

Wait until the event is fired as much as specified number of milliseconds. If it is already fired, returns immediately the result passed to the fire(Object) call. Throws TimeoutException if the event is not fired in time.

Parameters:

milliseconds - maximum number of milliseconds to wait for the event to be fired. 0 value waits forever.

Returns:

the result passed to the fire(Object)

Throws:

java.lang.InterruptedException

java.util.concurrent.TimeoutException - if the event was not fired during the specified time

fire

public final void fire()