net.lecousin.framework.concurrent.synch

Class SynchronizationPoint<TError extends Exception>

java.lang.Object

net.lecousin.framework.concurrent.synch.SynchronizationPoint<TError>

Type Parameters:

TError - type of exception it may raise

All Implemented Interfaces:

Future<Void>, ISynchronizationPoint<TError>

Direct Known Subclasses:

JoinPoint

public class SynchronizationPoint<TError extends Exception>
extends Object
implements ISynchronizationPoint<TError>, Future<Void>

Simplest implementation of a synchronization point.

Constructor Summary

Constructors

Constructor and Description
SynchronizationPoint() Constructor.
SynchronizationPoint(boolean unblocked) Constructor with an initial state.
SynchronizationPoint(CancelException cancel) Create an unblocked point with a cancellation.
SynchronizationPoint(TError error) Create an unblocked point with an error.

Method Summary

Modifier and Type	Method and Description
void	block(long timeout) Pause the current thread to wait for this synchronization point to be unblocked.
void	blockPause(long logAfter) Really block, using wait method (used by threading system to know when a thread can be resumed).
boolean	cancel(boolean mayInterruptIfRunning)
void	cancel(CancelException reason) Cancel this synchronization point: unblock it immediately, and set the cancellation reason.
void	error(TError error) Unblock with an error.
Void	get()
Void	get(long timeout, TimeUnit unit)
Collection<?>	getAllListeners() Return a collection with all listeners, only for debugging purposes.
CancelException	getCancelEvent() Get the reason of the cancellation.
TError	getError() Return the error.
boolean	hasError() Return true if unblocked because of an error.
boolean	isCancelled() Return true if unblocked because of a cancellation.
boolean	isDone()
boolean	isUnblocked() Return true if unblocked (success or cancelled).
void	listenInline(Runnable r) Call listener when unblocked (whatever the result is successful, has error or is cancelled).
void	reset() Reset this synchronization point to reuse it.
void	restart() Same as the method reset except that listeners are kept.
void	unblock() Unblock this synchronization point without error.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.lecousin.framework.concurrent.synch.ISynchronizationPoint

blockException, blockThrow, forwardCancel, isSuccessful, listenAsync, listenAsync, listenAsyncSP, listenInline, listenInline, listenInline, listenInlineSP, listenInlineSP, onCancel, onError, onException, onSuccess, synchWithNoError, toAsyncWorkVoid

Constructor Detail

SynchronizationPoint

public SynchronizationPoint()

Constructor.

SynchronizationPoint

public SynchronizationPoint(boolean unblocked)

Constructor with an initial state.

SynchronizationPoint

public SynchronizationPoint(TError error)

Create an unblocked point with an error.

SynchronizationPoint

public SynchronizationPoint(CancelException cancel)

Create an unblocked point with a cancellation.

Method Detail

getAllListeners

public Collection<?> getAllListeners()

Description copied from interface: ISynchronizationPoint

Return a collection with all listeners, only for debugging purposes.

Specified by:

getAllListeners in interface ISynchronizationPoint<TError extends Exception>

listenInline

public void listenInline(Runnable r)

Description copied from interface: ISynchronizationPoint

Call listener when unblocked (whatever the result is successful, has error or is cancelled).

Specified by:

listenInline in interface ISynchronizationPoint<TError extends Exception>

unblock

public void unblock()

Unblock this synchronization point without error.

error

public void error(TError error)

Description copied from interface: ISynchronizationPoint

Unblock with an error.

Specified by:

error in interface ISynchronizationPoint<TError extends Exception>

cancel

public void cancel(CancelException reason)

Description copied from interface: ISynchronizationPoint

Cancel this synchronization point: unblock it immediately, and set the cancellation reason.

Specified by:

cancel in interface ISynchronizationPoint<TError extends Exception>

block

public void block(long timeout)

Description copied from interface: ISynchronizationPoint

Pause the current thread to wait for this synchronization point to be unblocked.

Specified by:

block in interface ISynchronizationPoint<TError extends Exception>

blockPause

public void blockPause(long logAfter)

Description copied from interface: ISynchronizationPoint

Really block, using wait method (used by threading system to know when a thread can be resumed).

Specified by:

blockPause in interface ISynchronizationPoint<TError extends Exception>

isUnblocked

public boolean isUnblocked()

Description copied from interface: ISynchronizationPoint

Return true if unblocked (success or cancelled).

Specified by:

isUnblocked in interface ISynchronizationPoint<TError extends Exception>

isCancelled

public boolean isCancelled()

Description copied from interface: ISynchronizationPoint

Return true if unblocked because of a cancellation.

Specified by:

isCancelled in interface Future<Void>

Specified by:

isCancelled in interface ISynchronizationPoint<TError extends Exception>

hasError

public boolean hasError()

Description copied from interface: ISynchronizationPoint

Return true if unblocked because of an error.

Specified by:

hasError in interface ISynchronizationPoint<TError extends Exception>

getCancelEvent

public CancelException getCancelEvent()

Description copied from interface: ISynchronizationPoint

Get the reason of the cancellation.

Specified by:

getCancelEvent in interface ISynchronizationPoint<TError extends Exception>

getError

public TError getError()

Description copied from interface: ISynchronizationPoint

Return the error.

Specified by:

getError in interface ISynchronizationPoint<TError extends Exception>

reset

public void reset()

Reset this synchronization point to reuse it. This method remove any previous error or cancellation and mark this synchronization point as blocked. Any previous listener is also removed, and won't be called.

restart

public void restart()

Same as the method reset except that listeners are kept.

get

public Void get()
         throws InterruptedException,
                ExecutionException

Specified by:

get in interface Future<Void>

Throws:

InterruptedException

ExecutionException

get

public Void get(long timeout,
                TimeUnit unit)
         throws InterruptedException,
                ExecutionException,
                TimeoutException

Specified by:

get in interface Future<Void>

Throws:

InterruptedException

ExecutionException

TimeoutException

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<Void>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<Void>