Modifier and Type	Class and Description
private class	SafeFutureImpl.Sync Synchronization control for FutureTask.

Modifier and Type	Field and Description
private final Object	chSync
private Set<CompletionHandler<R>>	completionHandlers
private final SafeFutureImpl<R>.Sync	sync Synchronization control for FutureTask

Access	Constructor and Description
public	SafeFutureImpl() Creates `SafeFutureImpl`

Method Summary

Modifier and Type	Method and Description
public void	addCompletionHandler(final CompletionHandler<R> completionHandler) Implements org.glassfish.grizzly.GrizzlyFuture.addCompletionHandler. Adds a `CompletionHandler`, which will be notified once the asynchronous computation, represented by this `Future`, is complete.
public boolean	cancel(boolean mayInterruptIfRunning) Implements java.util.concurrent.Future.cancel. Attempts to cancel execution of this task.
public static <R> SafeFutureImpl<R>	create() Construct `SafeFutureImpl`.
protected void	done() Protected method invoked when this task transitions to state `isDone` (whether normally or via cancellation).
public void	failure(Throwable failure) Implements org.glassfish.grizzly.impl.FutureImpl.failure. Notify about the failure, occurred during asynchronous operation execution.
public R	get() Implements java.util.concurrent.Future.get. Waits if necessary for the computation to complete, and then retrieves its result.
public R	get(long timeout, TimeUnit unit) Implements java.util.concurrent.Future.get. Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.
public R	getResult() Implements org.glassfish.grizzly.impl.FutureImpl.getResult. Get current result value without any blocking.
public boolean	isCancelled() Implements java.util.concurrent.Future.isCancelled. Returns `true` if this task was cancelled before it completed normally.
public boolean	isDone() Implements java.util.concurrent.Future.isDone. Returns `true` if this task completed.
public void	markForRecycle(boolean recycleResult) Implements org.glassfish.grizzly.GrizzlyFuture.markForRecycle. Mark `GrizzlyFuture` as recyclable, so once result will come - `GrizzlyFuture` object will be recycled and returned to a thread local object pool.
private void	notifyCompletionHandler(final CompletionHandler<R> completionHandler) Notify single `CompletionHandler` about the result.
private void	notifyCompletionHandlers() Notify registered `CompletionHandler`s about the result.
protected void	onComplete() The method is called when this `SafeFutureImpl` is marked as completed.
public void	recycle(boolean recycleResult) Implements org.glassfish.grizzly.GrizzlyFuture.recycle. Recycle `GrizzlyFuture` now.
public void	recycle() Implements org.glassfish.grizzly.Cacheable.recycle.
public void	result(R the result value result) Implements org.glassfish.grizzly.impl.FutureImpl.result. Set the result value and notify about operation completion.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

chSync	back to summary
private final Object chSync

completionHandlers	back to summary
private Set<CompletionHandler<R>> completionHandlers

sync	back to summary
private final SafeFutureImpl<R>.Sync sync Synchronization control for FutureTask

Constructor Detail

SafeFutureImpl back to summary

SafeFutureImpl	back to summary
public SafeFutureImpl() Creates `SafeFutureImpl` Annotations @SuppressWarnings:unchecked

public SafeFutureImpl()

Creates SafeFutureImpl

Annotations

@SuppressWarnings:unchecked

Method Detail

addCompletionHandler back to summary

addCompletionHandler	back to summary
public void addCompletionHandler(final CompletionHandler<R> completionHandler) Implements org.glassfish.grizzly.GrizzlyFuture.addCompletionHandler. Doc from org.glassfish.grizzly.GrizzlyFuture.addCompletionHandler. Adds a `CompletionHandler`, which will be notified once the asynchronous computation, represented by this `Future`, is complete. Annotations @Override

public void addCompletionHandler(final CompletionHandler<R> completionHandler)

Implements org.glassfish.grizzly.GrizzlyFuture.addCompletionHandler.

Doc from org.glassfish.grizzly.GrizzlyFuture.addCompletionHandler.

Adds a CompletionHandler, which will be notified once the asynchronous computation, represented by this Future, is complete.

Annotations

@Override

cancel back to summary

cancel	back to summary
public boolean cancel(boolean mayInterruptIfRunning) Implements java.util.concurrent.Future.cancel. Doc from java.util.concurrent.Future.cancel. Attempts to cancel execution of this task. This method has no effect if the task is already completed or cancelled, or could not be cancelled for some other reason. Otherwise, if this task has not started when `cancel` is called, this task should never run. If the task has already started, then the `mayInterruptIfRunning` parameter determines whether the thread executing this task (when known by the implementation) is interrupted in an attempt to stop the task. The return value from this method does not necessarily indicate whether the task is now cancelled; use `isCancelled`. Annotations @Override

public boolean cancel(boolean mayInterruptIfRunning)

Implements java.util.concurrent.Future.cancel.

Doc from java.util.concurrent.Future.cancel.

Attempts to cancel execution of this task. This method has no effect if the task is already completed or cancelled, or could not be cancelled for some other reason. Otherwise, if this task has not started when cancel is called, this task should never run. If the task has already started, then the mayInterruptIfRunning parameter determines whether the thread executing this task (when known by the implementation) is interrupted in an attempt to stop the task.

The return value from this method does not necessarily indicate whether the task is now cancelled; use isCancelled.

Annotations

@Override

create back to summary

create	back to summary
public static <R> SafeFutureImpl<R> create() Construct `SafeFutureImpl`. Annotations @SuppressWarnings:unchecked

public static <R> SafeFutureImpl<R> create()

Construct SafeFutureImpl.

Annotations

@SuppressWarnings:unchecked

done	back to summary
protected void done() Protected method invoked when this task transitions to state `isDone` (whether normally or via cancellation). The default implementation does nothing. Subclasses may override this method to invoke completion callbacks or perform bookkeeping. Note that you can query status inside the implementation of this method to determine whether this task has been cancelled.

failure	back to summary
public void failure(Throwable failure) Implements org.glassfish.grizzly.impl.FutureImpl.failure. Notify about the failure, occurred during asynchronous operation execution. Annotations @Override

failure

back to summary

public void failure(Throwable failure)

Implements org.glassfish.grizzly.impl.FutureImpl.failure.

Notify about the failure, occurred during asynchronous operation execution.

Annotations

@Override

get	back to summary
public R get() throws InterruptedException, ExecutionException Implements java.util.concurrent.Future.get. Doc from java.util.concurrent.Future.get. Waits if necessary for the computation to complete, and then retrieves its result. Annotations @Override Exceptions InterruptedException: if the current thread was interrupted while waiting ExecutionException: if the computation threw an exception CancellationException: if the computation was cancelled

get

back to summary

public R get() throws InterruptedException, ExecutionException

Implements java.util.concurrent.Future.get.

Doc from java.util.concurrent.Future.get.

Waits if necessary for the computation to complete, and then retrieves its result.

Annotations

@Override

Exceptions

InterruptedException:: if the current thread was interrupted while waiting
ExecutionException:: if the computation threw an exception
CancellationException:: if the computation was cancelled

get	back to summary
public R get(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException Implements java.util.concurrent.Future.get. Doc from java.util.concurrent.Future.get. Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available. Annotations @Override Exceptions InterruptedException: if the current thread was interrupted while waiting ExecutionException: if the computation threw an exception TimeoutException: if the wait timed out CancellationException: if the computation was cancelled

get

back to summary

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

Implements java.util.concurrent.Future.get.

Doc from java.util.concurrent.Future.get.

Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.

Annotations

@Override

Exceptions

InterruptedException:: if the current thread was interrupted while waiting
ExecutionException:: if the computation threw an exception
TimeoutException:: if the wait timed out
CancellationException:: if the computation was cancelled

getResult	back to summary
public R getResult() Implements org.glassfish.grizzly.impl.FutureImpl.getResult. Doc from org.glassfish.grizzly.impl.FutureImpl.getResult. Get current result value without any blocking. Annotations @Override

getResult

back to summary

public R getResult()

Implements org.glassfish.grizzly.impl.FutureImpl.getResult.

Doc from org.glassfish.grizzly.impl.FutureImpl.getResult.

Get current result value without any blocking.

Annotations

@Override

isCancelled back to summary

isCancelled	back to summary
public boolean isCancelled() Implements java.util.concurrent.Future.isCancelled. Doc from java.util.concurrent.Future.isCancelled. Returns `true` if this task was cancelled before it completed normally. Annotations @Override

public boolean isCancelled()

Implements java.util.concurrent.Future.isCancelled.

Doc from java.util.concurrent.Future.isCancelled.

Returns true if this task was cancelled before it completed normally.

Annotations

@Override

isDone back to summary

isDone	back to summary
public boolean isDone() Implements java.util.concurrent.Future.isDone. Doc from java.util.concurrent.Future.isDone. Returns `true` if this task completed. Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will return `true`. Annotations @Override

public boolean isDone()

Implements java.util.concurrent.Future.isDone.

Doc from java.util.concurrent.Future.isDone.

Returns true if this task completed. Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will return true.

Annotations

@Override

markForRecycle back to summary

markForRecycle	back to summary
public void markForRecycle(boolean recycleResult) Implements org.glassfish.grizzly.GrizzlyFuture.markForRecycle. Doc from org.glassfish.grizzly.GrizzlyFuture.markForRecycle. Mark `GrizzlyFuture` as recyclable, so once result will come - `GrizzlyFuture` object will be recycled and returned to a thread local object pool. You can consider to use this method, if you're not interested in using this `GrizzlyFuture` object. Annotations @Override

public void markForRecycle(boolean recycleResult)

Implements org.glassfish.grizzly.GrizzlyFuture.markForRecycle.

Doc from org.glassfish.grizzly.GrizzlyFuture.markForRecycle.

Mark GrizzlyFuture as recyclable, so once result will come - GrizzlyFuture object will be recycled and returned to a thread local object pool. You can consider to use this method, if you're not interested in using this GrizzlyFuture object.

Annotations

@Override

notifyCompletionHandler	back to summary
private void notifyCompletionHandler(final CompletionHandler<R> completionHandler) Notify single `CompletionHandler` about the result.

notifyCompletionHandlers	back to summary
private void notifyCompletionHandlers() Notify registered `CompletionHandler`s about the result.

onComplete	back to summary
protected void onComplete() The method is called when this `SafeFutureImpl` is marked as completed. Subclasses can override this method.

recycle back to summary

recycle	back to summary
public void recycle(boolean recycleResult) Implements org.glassfish.grizzly.GrizzlyFuture.recycle. Doc from org.glassfish.grizzly.GrizzlyFuture.recycle. Recycle `GrizzlyFuture` now. This method could be used, if you're not interested in using this `GrizzlyFuture` object, and you're sure this object is not used by any other application part. Annotations @Override

public void recycle(boolean recycleResult)

Implements org.glassfish.grizzly.GrizzlyFuture.recycle.

Doc from org.glassfish.grizzly.GrizzlyFuture.recycle.

Recycle GrizzlyFuture now. This method could be used, if you're not interested in using this GrizzlyFuture object, and you're sure this object is not used by any other application part.

Annotations

@Override

recycle	back to summary
public void recycle() Implements org.glassfish.grizzly.Cacheable.recycle. Annotations @Override

recycle

back to summary

public void recycle()

Implements org.glassfish.grizzly.Cacheable.recycle.

Annotations

@Override

result	back to summary
public void result(R result) Implements org.glassfish.grizzly.impl.FutureImpl.result. Set the result value and notify about operation completion. Parameters result:R the result value Annotations @Override

result

back to summary

public void result(R result)

Implements org.glassfish.grizzly.impl.FutureImpl.result.

Set the result value and notify about operation completion.

Parameters

result:R: the result value

Annotations

@Override

org.glassfish.grizzly.impl back to summary

private final Class SafeFutureImpl.Sync

Class Inheritance

extends AbstractQueuedSynchronizer

java.lang.Object
java.util.concurrent.locks.AbstractOwnableSynchronizer
java.util.concurrent.locks.AbstractQueuedSynchronizer
org.glassfish.grizzly.impl.SafeFutureImpl.Sync

Synchronization control for FutureTask. Note that this must be a non-static inner class in order to invoke the protected done method. For clarity, all inner class support methods are same as outer, prefixed with "inner".

Uses AQS sync state to represent run status

Field Summary

Modifier and Type	Field and Description
private static final int	CANCELLED Hides java.util.concurrent.locks.AbstractQueuedSynchronizer.CANCELLED. State value representing that task was cancelled
private Throwable	exception The exception to throw from get()
private static final int	RAN State value representing that task ran
private static final int	READY State value representing that task is ready to run
private static final int	RESULT State value representing that result/exception is being set
private R	result The result to return from get()
private static final long	serialVersionUID Hides java.util.concurrent.locks.AbstractQueuedSynchronizer.serialVersionUID.

Constructor Summary

Access	Constructor and Description
private	Sync()

Method Summary

Modifier and Type	Method and Description
pack-priv boolean	innerCancel(boolean mayInterruptIfRunning)
pack-priv R	innerGet()
pack-priv R	innerGet(long nanosTimeout)
pack-priv boolean	innerIsCancelled()
pack-priv void	innerSet(R v)
pack-priv void	innerSetException(Throwable t)
private boolean	ranOrCancelled()
protected int	tryAcquireShared(int ignore) Overrides java.util.concurrent.locks.AbstractQueuedSynchronizer.tryAcquireShared. Implements AQS base acquire to succeed if ran or cancelled
protected boolean	tryReleaseShared(int ignore) Overrides java.util.concurrent.locks.AbstractQueuedSynchronizer.tryReleaseShared. Implements AQS base release to always signal after setting final done status by nulling runner thread.

Field Detail

CANCELLED	back to summary
private static final int CANCELLED Hides java.util.concurrent.locks.AbstractQueuedSynchronizer.CANCELLED. State value representing that task was cancelled

CANCELLED

back to summary

private static final int CANCELLED

Hides java.util.concurrent.locks.AbstractQueuedSynchronizer.CANCELLED.

State value representing that task was cancelled

exception	back to summary
private Throwable exception The exception to throw from get()

RAN	back to summary
private static final int RAN State value representing that task ran

READY	back to summary
private static final int READY State value representing that task is ready to run

RESULT	back to summary
private static final int RESULT State value representing that result/exception is being set

result	back to summary
private R result The result to return from get()

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.util.concurrent.locks.AbstractQueuedSynchronizer.serialVersionUID.

Constructor Detail

Sync	back to summary
private Sync()

Method Detail

innerCancel	back to summary
pack-priv boolean innerCancel(boolean mayInterruptIfRunning)

innerGet	back to summary
pack-priv R innerGet() throws InterruptedException, ExecutionException

innerGet	back to summary
pack-priv R innerGet(long nanosTimeout) throws InterruptedException, ExecutionException, TimeoutException

innerIsCancelled	back to summary
pack-priv boolean innerIsCancelled()

innerSet	back to summary
pack-priv void innerSet(R v)

innerSetException	back to summary
pack-priv void innerSetException(Throwable t)

ranOrCancelled	back to summary
private boolean ranOrCancelled()

tryAcquireShared	back to summary
protected int tryAcquireShared(int ignore) Overrides java.util.concurrent.locks.AbstractQueuedSynchronizer.tryAcquireShared. Implements AQS base acquire to succeed if ran or cancelled Annotations @Override

tryAcquireShared

back to summary

protected int tryAcquireShared(int ignore)

Overrides java.util.concurrent.locks.AbstractQueuedSynchronizer.tryAcquireShared.

Implements AQS base acquire to succeed if ran or cancelled

Annotations

@Override

tryReleaseShared	back to summary
protected boolean tryReleaseShared(int ignore) Overrides java.util.concurrent.locks.AbstractQueuedSynchronizer.tryReleaseShared. Implements AQS base release to always signal after setting final done status by nulling runner thread. Annotations @Override

tryReleaseShared

back to summary

protected boolean tryReleaseShared(int ignore)

Overrides java.util.concurrent.locks.AbstractQueuedSynchronizer.tryReleaseShared.

Implements AQS base release to always signal after setting final done status by nulling runner thread.

Annotations

@Override

public Class SafeFutureImpl<R>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class SafeFutureImpl.Sync

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail