org.apache.sshd.common.future

Class DefaultSshFuture<T extends SshFuture>

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.future.DefaultSshFuture<T>

All Implemented Interfaces:

SshFuture<T>

Direct Known Subclasses:

AbstractIoWriteFuture, ChannelAsyncInputStream.IoReadFutureImpl, DefaultAuthFuture, DefaultCloseFuture, DefaultConnectFuture, DefaultOpenFuture

public class DefaultSshFuture<T extends SshFuture>
extends AbstractLoggingBean
implements SshFuture<T>

A default implementation of SshFuture.

Author:

Apache MINA SSHD Project

Field Summary

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Constructor Summary

Constructors

Constructor and Description
DefaultSshFuture(Object lock) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
T	addListener(SshFutureListener<T> listener) Adds an event listener which is notified when this future is completed.
T	await() Wait for the asynchronous operation to complete.
boolean	await(long timeoutMillis) Wait for the asynchronous operation to complete with the specified timeout.
boolean	await(long timeout, TimeUnit unit) Wait for the asynchronous operation to complete with the specified timeout.
protected Object	await0(long timeoutMillis, boolean interruptable) Wait for the Future to be ready.
T	awaitUninterruptibly() Wait for the asynchronous operation to complete uninterruptibly.
boolean	awaitUninterruptibly(long timeoutMillis) Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.
boolean	awaitUninterruptibly(long timeout, TimeUnit unit) Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.
void	cancel()
protected Object	getValue()
boolean	isCanceled()
boolean	isDone()
T	removeListener(SshFutureListener<T> listener) Removes an existing event listener so it won't be notified when the future is completed.
void	setValue(Object newValue) Sets the result of the asynchronous operation, and mark it as finished.
protected <R> R	verifyResult(Class<? extends R> expectedType, long timeout) Waits (interruptible) for the specified timeout (msec.) and then checks the result:

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSshFuture

public DefaultSshFuture(Object lock)

Creates a new instance.

Parameters:

lock - A synchronization object for locking access - if null then synchronization occurs on this instance

Method Detail

await

public T await()
        throws IOException

Description copied from interface: SshFuture

Wait for the asynchronous operation to complete. The attached listeners will be notified when the operation is completed.

Specified by:

await in interface SshFuture<T extends SshFuture>

Returns:

The this instance

Throws:

IOException - if failed - specifically InterruptedIOException if waiting was interrupted

await

public boolean await(long timeout,
                     TimeUnit unit)
              throws IOException

Description copied from interface: SshFuture

Wait for the asynchronous operation to complete with the specified timeout.

Specified by:

await in interface SshFuture<T extends SshFuture>

Parameters:

timeout - The number of time units to wait

unit - The TimeUnit for waiting

Returns:

true if the operation is completed.

Throws:

IOException - if failed - specifically InterruptedIOException if waiting was interrupted

await

public boolean await(long timeoutMillis)
              throws IOException

Description copied from interface: SshFuture

Wait for the asynchronous operation to complete with the specified timeout.

Specified by:

await in interface SshFuture<T extends SshFuture>

Parameters:

timeoutMillis - Wait time in milliseconds

Returns:

true if the operation is completed.

Throws:

IOException - if failed - specifically InterruptedIOException if waiting was interrupted

awaitUninterruptibly

public T awaitUninterruptibly()

Description copied from interface: SshFuture

Wait for the asynchronous operation to complete uninterruptibly. The attached listeners will be notified when the operation is completed.

Specified by:

awaitUninterruptibly in interface SshFuture<T extends SshFuture>

Returns:

the current future

awaitUninterruptibly

public boolean awaitUninterruptibly(long timeout,
                                    TimeUnit unit)

Description copied from interface: SshFuture

Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.

Specified by:

awaitUninterruptibly in interface SshFuture<T extends SshFuture>

Parameters:

timeout - The number of time units to wait

unit - The TimeUnit for waiting

Returns:

true if the operation is completed.

awaitUninterruptibly

public boolean awaitUninterruptibly(long timeoutMillis)

Description copied from interface: SshFuture

Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.

Specified by:

awaitUninterruptibly in interface SshFuture<T extends SshFuture>

Parameters:

timeoutMillis - Wait time in milliseconds

Returns:

true if the operation is finished.

verifyResult

protected <R> R verifyResult(Class<? extends R> expectedType,
                             long timeout)
                      throws IOException

Waits (interruptible) for the specified timeout (msec.) and then checks the result:

• If result is null then timeout is assumed to have expired - throw an appropriate IOException

• If the result is of the expected type, then cast and return it

• If the result is an IOException then re-throw it

• If the result is a Throwable then throw an IOException whose cause is the original exception

• Otherwise (should never happen), throw a StreamCorruptedException with the name of the result type

Type Parameters:

R - The generic result type

Parameters:

expectedType - The expected result type

timeout - The timeout (millis) to wait for a result

Returns:

The (never null) result

Throws:

IOException - If failed to retrieve the expected result on time

await0

protected Object await0(long timeoutMillis,
                        boolean interruptable)
                 throws InterruptedIOException

Wait for the Future to be ready. If the requested delay is 0 or negative, this method immediately returns.

Parameters:

timeoutMillis - The delay we will wait for the Future to be ready

interruptable - Tells if the wait can be interrupted or not. If true and the thread is interrupted then an InterruptedIOException is thrown.

Returns:

The non-null result object if the Future is ready, null if the timeout expired and no result was received

Throws:

InterruptedIOException - If the thread has been interrupted when it's not allowed.

isDone

public boolean isDone()

Specified by:

isDone in interface SshFuture<T extends SshFuture>

Returns:

true if the asynchronous operation is completed.

setValue

public void setValue(Object newValue)

Sets the result of the asynchronous operation, and mark it as finished.

Parameters:

newValue - The operation result

getValue

protected Object getValue()

Returns:

The result of the asynchronous operation.

addListener

public T addListener(SshFutureListener<T> listener)

Description copied from interface: SshFuture

Adds an event listener which is notified when this future is completed. If the listener is added after the completion, the listener is directly notified.

Specified by:

addListener in interface SshFuture<T extends SshFuture>

Parameters:

listener - The SshFutureListener instance to add

Returns:

The future instance

removeListener

public T removeListener(SshFutureListener<T> listener)

Description copied from interface: SshFuture

Removes an existing event listener so it won't be notified when the future is completed.

Specified by:

removeListener in interface SshFuture<T extends SshFuture>

Parameters:

listener - The SshFutureListener instance to remove

Returns:

The future instance

isCanceled

public boolean isCanceled()

cancel

public void cancel()