org.snf4j.core.future

Class RegisterFuture<V>

java.lang.Object

org.snf4j.core.future.AbstractFuture<V>

org.snf4j.core.future.TaskFuture<V>

org.snf4j.core.future.RegisterFuture<V>

All Implemented Interfaces:

Future<V>, IAbortableFuture<V>, IFuture<V>

public class RegisterFuture<V>
extends TaskFuture<V>

A future that represents the result of the asynchronous register methods of selector loops.

Author:

SNF4J.ORG

Constructor Summary

Constructors

Constructor and Description
RegisterFuture(ISession session) Constructs a register future associated with a session.

Method Summary

Modifier and Type	Method and Description
IFuture<V>	await() Waits for this future to be completed.
IFuture<V>	await(long timeoutMillis) Waits for this future to be completed within the specified time limit.
IFuture<V>	await(long timeout, TimeUnit unit) Waits for this future to be completed within the specified time limit.
IFuture<V>	awaitUninterruptibly() Waits for this future to be completed without interruption.
IFuture<V>	awaitUninterruptibly(long timeoutMillis) Waits for this future to be completed within the specified time limit without interruption.
IFuture<V>	awaitUninterruptibly(long timeout, TimeUnit unit) Waits for this future to be completed within the specified time limit without interruption.
boolean	cancel(boolean arg0)
Throwable	cause() Returns the cause of the failed I/O operation.
V	get()
V	get(long timeout, TimeUnit unit)
protected org.snf4j.core.future.FutureLock	getLock()
IFuture<V>	sync() Waits for this future to be completed, and throws an exception that wraps the cause of the failure if this future failed.
IFuture<V>	sync(long timeoutMillis) Waits for this future to be completed within the specified time limit, and throws an exception that wraps the cause of the failure if this future failed.
IFuture<V>	sync(long timeout, TimeUnit unit) Waits for this future to be completed within the specified time limit, and throws an exception that wraps the cause of the failure if this future failed.
IFuture<V>	syncUninterruptibly() Waits for this future to be completed without interruption, and throws an exception that wraps the cause of the failure if this future failed.
IFuture<V>	syncUninterruptibly(long timeoutMillis) Waits for this future to be completed within the specified time limit without interruption, and throws an exception that wraps the cause of the failure if this future failed.
IFuture<V>	syncUninterruptibly(long timeout, TimeUnit unit) Waits for this future to be completed within the specified time limit without interruption, and throws an exception that wraps the cause of the failure if this future failed.

Methods inherited from class org.snf4j.core.future.TaskFuture

abort, success

Methods inherited from class org.snf4j.core.future.AbstractFuture

getNow, getSession, isCancelled, isDone, isFailed, isSuccessful, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.snf4j.core.future.IFuture

await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, cause, getNow, getSession, isFailed, isSuccessful, sync, sync, sync, syncUninterruptibly, syncUninterruptibly, syncUninterruptibly

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Constructor Detail

RegisterFuture

public RegisterFuture(ISession session)

Constructs a register future associated with a session.

Parameters:

session - the session this future is associated with, or null if this future is not associated with any session

Method Detail

getLock

protected org.snf4j.core.future.FutureLock getLock()

await

public IFuture<V> await()
                 throws InterruptedException

Description copied from interface: IFuture

Waits for this future to be completed.

Returns:

this future

Throws:

InterruptedException - if the current thread was interrupted.

await

public IFuture<V> await(long timeoutMillis)
                 throws InterruptedException

Description copied from interface: IFuture

Waits for this future to be completed within the specified time limit.

Parameters:

timeoutMillis - the time limit in milliseconds to wait

Returns:

this future

Throws:

InterruptedException - if the current thread was interrupted.

await

public IFuture<V> await(long timeout,
                        TimeUnit unit)
                 throws InterruptedException

Description copied from interface: IFuture

Waits for this future to be completed within the specified time limit.

Parameters:

timeout - the time limit to wait

unit - the time unit of the time limit

Returns:

this future

Throws:

InterruptedException - if the current thread was interrupted.

awaitUninterruptibly

public IFuture<V> awaitUninterruptibly()

Description copied from interface: IFuture

Waits for this future to be completed without interruption.

Returns:

this future

awaitUninterruptibly

public IFuture<V> awaitUninterruptibly(long timeoutMillis)

Description copied from interface: IFuture

Waits for this future to be completed within the specified time limit without interruption.

Parameters:

timeoutMillis - the time limit in milliseconds to wait

Returns:

this future

awaitUninterruptibly

public IFuture<V> awaitUninterruptibly(long timeout,
                                       TimeUnit unit)

Description copied from interface: IFuture

Waits for this future to be completed within the specified time limit without interruption.

Parameters:

timeout - the time limit to wait

unit - the time unit of the time limit

Returns:

this future

sync

public IFuture<V> sync()
                throws InterruptedException,
                       ExecutionException

Description copied from interface: IFuture

Waits for this future to be completed, and throws an exception that wraps the cause of the failure if this future failed.

Returns:

this future

Throws:

InterruptedException - if the current thread was interrupted.

ExecutionException - if this future failed

sync

public IFuture<V> sync(long timeoutMillis)
                throws InterruptedException,
                       ExecutionException,
                       TimeoutException

Description copied from interface: IFuture

Waits for this future to be completed within the specified time limit, and throws an exception that wraps the cause of the failure if this future failed.

Parameters:

timeoutMillis - the time limit in milliseconds to wait

Returns:

this future

Throws:

InterruptedException - if the current thread was interrupted.

ExecutionException - if this future failed

TimeoutException - if the time limit expired without completion of this future

sync

public IFuture<V> sync(long timeout,
                       TimeUnit unit)
                throws InterruptedException,
                       ExecutionException,
                       TimeoutException

Description copied from interface: IFuture

Waits for this future to be completed within the specified time limit, and throws an exception that wraps the cause of the failure if this future failed.

Parameters:

timeout - the time limit to wait

unit - the time unit of the time limit

Returns:

this future

Throws:

InterruptedException - if the current thread was interrupted.

ExecutionException - if this future failed

TimeoutException - if the time limit expired without completion of this future

syncUninterruptibly

public IFuture<V> syncUninterruptibly()
                               throws ExecutionException

Description copied from interface: IFuture

Waits for this future to be completed without interruption, and throws an exception that wraps the cause of the failure if this future failed.

Returns:

this future

Throws:

ExecutionException - if this future failed

syncUninterruptibly

public IFuture<V> syncUninterruptibly(long timeoutMillis)
                               throws ExecutionException,
                                      TimeoutException

Description copied from interface: IFuture

Waits for this future to be completed within the specified time limit without interruption, and throws an exception that wraps the cause of the failure if this future failed.

Parameters:

timeoutMillis - the time limit in milliseconds to wait

Returns:

this future

Throws:

ExecutionException - if this future failed

TimeoutException - if the time limit expired without completion of this future

syncUninterruptibly

public IFuture<V> syncUninterruptibly(long timeout,
                                      TimeUnit unit)
                               throws ExecutionException,
                                      TimeoutException

Description copied from interface: IFuture

Waits for this future to be completed within the specified time limit without interruption, and throws an exception that wraps the cause of the failure if this future failed.

Parameters:

timeout - the time limit to wait

unit - the time unit of the time limit

Returns:

this future

Throws:

ExecutionException - if this future failed

TimeoutException - if the time limit expired without completion of this future

get

public V get()
      throws InterruptedException,
             ExecutionException

Throws:

InterruptedException

ExecutionException

get

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

Throws:

InterruptedException

ExecutionException

TimeoutException

cancel

public boolean cancel(boolean arg0)

cause

public Throwable cause()

Description copied from interface: IFuture

Returns the cause of the failed I/O operation.

Returns:

the cause of the failure, or null if succeeded or this future is not completed yet.