org.gridgain.grid.util.nio

Interface GridNioFuture<R>

Type Parameters:

R - Type of the result for the future.

All Known Implementing Classes:

GridNioEmbeddedFuture, GridNioFinishedFuture, GridNioFutureImpl

public interface GridNioFuture<R>

Reduced variant of GridFuture interface. Removed asynchronous listen methods which require a valid grid kernal context.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancel() Cancels this future.
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.
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.

Method Detail

get

R get()
      throws IOException,
             GridException

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

Returns:

Operation result.

Throws:

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

GridFutureCancelledException - Subclass of GridException throws if operation was cancelled.

GridException - If operation failed.

IOException - If IOException occurred while performing operation.

get

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).

Parameters:

timeout - The maximum time to wait in milliseconds.

Returns:

Operation result.

Throws:

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.

IOException - If IOException occurred while performing operation.

get

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.

Parameters:

timeout - The maximum time to wait.

unit - The time unit of the timeout argument.

Returns:

Operation result.

Throws:

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.

IOException - If IOException occurred while performing operation.

cancel

boolean cancel()
               throws GridException

Cancels this future.

Returns:

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

Throws:

GridException - If cancellation failed.

isDone

boolean isDone()

Checks if operation is done.

Returns:

True if operation is done, false otherwise.

isCancelled

boolean isCancelled()

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

Returns:

True if this operation was cancelled before it completed normally.

listenAsync

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

Registers listener closure to be asynchronously notified whenever future completes.

Parameters:

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

messageThread

void messageThread(boolean msgThread)

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

Parameters:

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

messageThread

boolean messageThread()

Returns:

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