org.apache.sshd.common.future

Interface SshFuture<T extends SshFuture>

All Known Subinterfaces:

AuthFuture, CloseFuture, ConnectFuture, IoConnectFuture, IoReadFuture, IoWriteFuture, OpenFuture

All Known Implementing Classes:

AbstractIoWriteFuture, ChannelAsyncInputStream.IoReadFutureImpl, DefaultAuthFuture, DefaultCloseFuture, DefaultConnectFuture, DefaultOpenFuture, DefaultSshFuture, IoWriteFutureImpl, Nio2DefaultIoWriteFuture, PendingWriteFuture

public interface SshFuture<T extends SshFuture>

Represents the completion of an asynchronous SSH operation on a given object (it may be an SSH session or an SSH channel). Can be listened for completion using a SshFutureListener.

Author:

Apache MINA SSHD Project

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.
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.
boolean	isDone()
T	removeListener(SshFutureListener<T> listener) Removes an existing event listener so it won't be notified when the future is completed.

Method Detail

await

T await()
 throws IOException

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

Returns:

The this instance

Throws:

IOException - if failed - specifically InterruptedIOException if waiting was interrupted

await

boolean await(long timeout,
              TimeUnit unit)
       throws IOException

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

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

boolean await(long timeoutMillis)
       throws IOException

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

Parameters:

timeoutMillis - Wait time in milliseconds

Returns:

true if the operation is completed.

Throws:

IOException - if failed - specifically InterruptedIOException if waiting was interrupted

awaitUninterruptibly

T awaitUninterruptibly()

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

Returns:

the current future

awaitUninterruptibly

boolean awaitUninterruptibly(long timeout,
                             TimeUnit unit)

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

Parameters:

timeout - The number of time units to wait

unit - The TimeUnit for waiting

Returns:

true if the operation is completed.

awaitUninterruptibly

boolean awaitUninterruptibly(long timeoutMillis)

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

Parameters:

timeoutMillis - Wait time in milliseconds

Returns:

true if the operation is finished.

isDone

boolean isDone()

Returns:

true if the asynchronous operation is completed.

addListener

T addListener(SshFutureListener<T> listener)

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.

Parameters:

listener - The SshFutureListener instance to add

Returns:

The future instance

removeListener

T removeListener(SshFutureListener<T> listener)

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

Parameters:

listener - The SshFutureListener instance to remove

Returns:

The future instance