org.gridgain.grid.util.nio

Class GridNioFutureImpl<R>

java.lang.Object

java.util.concurrent.locks.AbstractOwnableSynchronizer

java.util.concurrent.locks.AbstractQueuedSynchronizer

org.gridgain.grid.util.nio.GridNioFutureImpl<R>

All Implemented Interfaces:

Serializable, GridNioFuture<R>

Direct Known Subclasses:

GridNioEmbeddedFuture

public class GridNioFutureImpl<R>
extends AbstractQueuedSynchronizer
implements GridNioFuture<R>

Default future implementation.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.locks.AbstractQueuedSynchronizer

AbstractQueuedSynchronizer.ConditionObject

Field Summary

Fields

Modifier and Type	Field and Description
protected long	endTime
protected boolean	msgThread
protected long	startTime Future start time.

Constructor Summary

Constructors

Constructor and Description
GridNioFutureImpl()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancel() Default no-op implementation that always returns false.
protected Throwable	error()
R	get() Synchronously waits for completion of the operation and returns operation result.
R	get(long timeout) Synchronously waits for completion of the operation for up to the timeout specified and returns operation result.
R	get(long timeout, TimeUnit unit) Synchronously waits for completion of the operation for up to the timeout specified and returns operation result.
protected R	get0(long nanosTimeout)
boolean	isCancelled() Returns true if this operation was cancelled before it completed normally.
boolean	isDone() Checks if operation is done.
void	listenAsync(GridInClosure<? super GridNioFuture<R>> lsnr) Registers listener closure to be asynchronously notified whenever future completes.
boolean	messageThread()
void	messageThread(boolean msgThread) Sets flag indicating that message send future was created in thread that was processing a message.
boolean	onCancelled() Callback to notify that future is cancelled.
boolean	onDone() Callback to notify that future is finished with null result.
boolean	onDone(R res) Callback to notify that future is finished.
boolean	onDone(R res, Throwable err) Callback to notify that future is finished.
boolean	onDone(Throwable err) Callback to notify that future is finished.
protected R	result()
String	toString()
protected int	tryAcquireShared(int ignore)
protected boolean	tryReleaseShared(int ignore)

Methods inherited from class java.util.concurrent.locks.AbstractQueuedSynchronizer

acquire, acquireInterruptibly, acquireShared, acquireSharedInterruptibly, compareAndSetState, getExclusiveQueuedThreads, getFirstQueuedThread, getQueuedThreads, getQueueLength, getSharedQueuedThreads, getState, getWaitingThreads, getWaitQueueLength, hasContended, hasQueuedPredecessors, hasQueuedThreads, hasWaiters, isHeldExclusively, isQueued, owns, release, releaseShared, setState, tryAcquire, tryAcquireNanos, tryAcquireSharedNanos, tryRelease

Methods inherited from class java.util.concurrent.locks.AbstractOwnableSynchronizer

getExclusiveOwnerThread, setExclusiveOwnerThread

Methods inherited from class java.lang.Object

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

Field Detail

startTime

protected final long startTime

Future start time.

endTime

protected volatile long endTime

msgThread

protected boolean msgThread

Constructor Detail

GridNioFutureImpl

public GridNioFutureImpl()

Method Detail

error

protected Throwable error()

Returns:

Value of error.

result

protected R result()

Returns:

Value of result.

get

public R get()
      throws IOException,
             GridException

Synchronously waits for completion of the operation and returns operation result.

Specified by:

get in interface GridNioFuture<R>

Returns:

Operation result.

Throws:

IOException - If IOException occurred while performing operation.

GridInterruptedException - Subclass of GridException thrown if the wait was interrupted.

GridFutureCancelledException - Subclass of GridException throws if operation was cancelled.

GridException - If operation failed.

get

public R get(long timeout)
      throws IOException,
             GridException

Synchronously waits for completion of the operation for up to the timeout specified and returns operation result. This method is equivalent to calling get(long, TimeUnit.MILLISECONDS).

Specified by:

get in interface GridNioFuture<R>

Parameters:

timeout - The maximum time to wait in milliseconds.

Returns:

Operation result.

Throws:

IOException - If IOException occurred while performing operation.

GridInterruptedException - Subclass of GridException thrown if the wait was interrupted.

GridFutureTimeoutException - Subclass of GridException thrown if the wait was timed out.

GridFutureCancelledException - Subclass of GridException throws if operation was cancelled.

GridException - If operation failed.

get

public R get(long timeout,
    TimeUnit unit)
      throws IOException,
             GridException

Synchronously waits for completion of the operation for up to the timeout specified and returns operation result.

Specified by:

get in interface GridNioFuture<R>

Parameters:

timeout - The maximum time to wait.

unit - The time unit of the timeout argument.

Returns:

Operation result.

Throws:

IOException - If IOException occurred while performing operation.

GridInterruptedException - Subclass of GridException thrown if the wait was interrupted.

GridFutureTimeoutException - Subclass of GridException thrown if the wait was timed out.

GridFutureCancelledException - Subclass of GridException throws if operation was cancelled.

GridException - If operation failed.

get0

@Nullable
protected R get0(long nanosTimeout)
          throws InterruptedException,
                 GridException

Parameters:

nanosTimeout - Timeout (nanoseconds).

Returns:

Result.

Throws:

InterruptedException - If interrupted.

GridFutureTimeoutException - If timeout reached before computation completed.

GridException - If error occurred.

cancel

public boolean cancel()
               throws GridException

Default no-op implementation that always returns false. Futures that do support cancellation should override this method and call onCancelled() callback explicitly if cancellation indeed did happen.

Specified by:

cancel in interface GridNioFuture<R>

Returns:

True if future was canceled (i.e. was not finished prior to this call).

Throws:

GridException - If cancellation failed.

isDone

public boolean isDone()

Checks if operation is done.

Specified by:

isDone in interface GridNioFuture<R>

Returns:

True if operation is done, false otherwise.

isCancelled

public boolean isCancelled()

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

Specified by:

isCancelled in interface GridNioFuture<R>

Returns:

True if this operation was cancelled before it completed normally.

listenAsync

public void listenAsync(@Nullable
               GridInClosure<? super GridNioFuture<R>> lsnr)

Registers listener closure to be asynchronously notified whenever future completes.

Specified by:

listenAsync in interface GridNioFuture<R>

Parameters:

lsnr - Listener closure to register. If not provided - this method is no-op.

messageThread

public void messageThread(boolean msgThread)

Sets flag indicating that message send future was created in thread that was processing a message.

Specified by:

messageThread in interface GridNioFuture<R>

Parameters:

msgThread - True if future was created in thread that is processing message.

messageThread

public boolean messageThread()

Specified by:

messageThread in interface GridNioFuture<R>

Returns:

True if future was created in thread that was processing message.

onDone

public final boolean onDone()

Callback to notify that future is finished with null result. This method must delegate to onDone(Object, Throwable) method.

Returns:

True if result was set by this call.

onDone

public final boolean onDone(@Nullable
             R res)

Callback to notify that future is finished. This method must delegate to onDone(Object, Throwable) method.

Parameters:

res - Result.

Returns:

True if result was set by this call.

onDone

public final boolean onDone(@Nullable
             Throwable err)

Callback to notify that future is finished. This method must delegate to onDone(Object, Throwable) method.

Parameters:

err - Error.

Returns:

True if result was set by this call.

onDone

public boolean onDone(@Nullable
             R res,
             @Nullable
             Throwable err)

Callback to notify that future is finished. Note that if non-null exception is passed in the result value will be ignored.

Parameters:

res - Optional result.

err - Optional error.

Returns:

True if result was set by this call.

onCancelled

public boolean onCancelled()

Callback to notify that future is cancelled.

Returns:

True if cancel flag was set by this call.

tryAcquireShared

protected final int tryAcquireShared(int ignore)

Overrides:

tryAcquireShared in class AbstractQueuedSynchronizer

tryReleaseShared

protected final boolean tryReleaseShared(int ignore)

Overrides:

tryReleaseShared in class AbstractQueuedSynchronizer

toString

public String toString()

Overrides:

toString in class AbstractQueuedSynchronizer