Package com.oracle.coherence.concurrent.executor.subscribers.internal

Class FutureSubscriber<T>

java.lang.Object

com.oracle.coherence.concurrent.executor.subscribers.internal.FutureSubscriber<T>

Type Parameters:

T - the result type

All Implemented Interfaces:

Task.Subscriber<T>, Future<T>

Direct Known Subclasses:

AnyFutureSubscriber, ClusteredExecutorService.CESRunnableFuture

public class FutureSubscriber<T>
extends Object
implements Future<T>, Task.Subscriber<T>

A Task.Subscriber that also implements Future.

Since:

21.12

Author:

bo, lh

Field Summary

Fields

Modifier and Type	Field	Description
protected AtomicBoolean	f_fCompleted	Completed.
protected AtomicBoolean	f_fError	Error.
protected Task.Coordinator<T>	m_coordinator	Task coordinator.
protected Result<T>	m_result	The result.

Constructor Summary

Constructors

Constructor	Description
FutureSubscriber()	Constructs a FutureSubscriber.

Method Summary

Modifier and Type	Method	Description
boolean	cancel(boolean mayInterruptIfRunning)
T	get()
T	get(long timeout, TimeUnit unit)
boolean	getCompleted()	Determines if the FutureSubscriber has been completed by a Task.Coordinator.
boolean	hasResult()	Determines if the AnyFutureSubscriber has been completed by a Task.Coordinator.
boolean	isCancelled()
boolean	isDone()
boolean	isSubscribed()	Determines if the FutureSubscriber has been subscribed to a Task.Coordinator.
void	onComplete()	Invoked by a Task.Coordinator when it is known that no additional Task.Subscriber method invocations will occur or has already been terminated by an error.
void	onError(Throwable throwable)	Invoked by a Task.Coordinator when an unrecoverable error was encountered, after which no other Task.Subscriber methods are invoked.
void	onNext(T result)	Invoked when a Task.Coordinator has produced an item for consumption.
void	onSubscribe(Task.Subscription subscription)	Invoked prior to the Task.Subscriber methods Task.Subscriber.onComplete(), Task.Subscriber.onError(Throwable) and Task.Subscriber.onNext(Object) being invoked for a Task.Subscription to a Task.Coordinator.
void	setCoordinator(Task.Coordinator<T> coordinator)	Set the coordinator.

Methods inherited from class java.lang.Object

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

Field Detail

m_coordinator

protected Task.Coordinator<T> m_coordinator

Task coordinator.

f_fCompleted

protected final AtomicBoolean f_fCompleted

Completed.

f_fError

protected final AtomicBoolean f_fError

Error.

m_result

protected Result<T> m_result

The result.

Constructor Detail

FutureSubscriber

public FutureSubscriber()

Constructs a FutureSubscriber.

Method Detail

setCoordinator

public void setCoordinator(Task.Coordinator<T> coordinator)

Set the coordinator.

Parameters:

coordinator - coordinator

onComplete

public void onComplete()

Description copied from interface: Task.Subscriber

Invoked by a Task.Coordinator when it is known that no additional Task.Subscriber method invocations will occur or has already been terminated by an error.

After this method is invoked no other Task.Subscriber methods will be called.

If this method throws an exception, the Task.Subscriber will be closed.

Specified by:

onComplete in interface Task.Subscriber<T>

onError

public void onError(Throwable throwable)

Description copied from interface: Task.Subscriber

Invoked by a Task.Coordinator when an unrecoverable error was encountered, after which no other Task.Subscriber methods are invoked.

If this method throws an exception, the Task.Subscriber will be closed.

Specified by:

onError in interface Task.Subscriber<T>

Parameters:

throwable - the error

onNext

public void onNext(T result)

Description copied from interface: Task.Subscriber

Invoked when a Task.Coordinator has produced an item for consumption.

If this method throws an exception, the Task.Subscriber will be closed.

Specified by:

onNext in interface Task.Subscriber<T>

Parameters:

result - the item (possibly null)

onSubscribe

public void onSubscribe(Task.Subscription subscription)

Description copied from interface: Task.Subscriber

Invoked prior to the Task.Subscriber methods Task.Subscriber.onComplete(), Task.Subscriber.onError(Throwable) and Task.Subscriber.onNext(Object) being invoked for a Task.Subscription to a Task.Coordinator.

Specified by:

onSubscribe in interface Task.Subscriber<T>

Parameters:

subscription - the Task.Subscription

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<T>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<T>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<T>

get

public T get()
      throws InterruptedException,
             ExecutionException

Specified by:

get in interface Future<T>

Throws:

InterruptedException

ExecutionException

get

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

Specified by:

get in interface Future<T>

Throws:

InterruptedException

ExecutionException

TimeoutException

getCompleted

public boolean getCompleted()

Determines if the FutureSubscriber has been completed by a Task.Coordinator.

Returns:

true if the FutureSubscriber has been completed, false otherwise

hasResult

public boolean hasResult()

Determines if the AnyFutureSubscriber has been completed by a Task.Coordinator.

Returns:

true if the AnyFutureSubscriber has been completed, false otherwise

isSubscribed

public boolean isSubscribed()

Determines if the FutureSubscriber has been subscribed to a Task.Coordinator.

Returns:

true if the FutureSubscriber has been subscribed, false otherwise