Package org.apache.sshd.contrib.common.io

Class EndlessWriteFuture

java.lang.Object

org.apache.sshd.contrib.common.io.EndlessWriteFuture

All Implemented Interfaces:

HasException, SshFuture<IoWriteFuture>, VerifiableFuture<IoWriteFuture>, WaitableFuture, IoWriteFuture

public class EndlessWriteFuture
extends java.lang.Object
implements IoWriteFuture

Never signals a successful write completion and ignores all listeners

Field Summary

Fields

Modifier and Type	Field	Description
static EndlessWriteFuture	INSTANCE

Constructor Summary

Constructors

Constructor	Description
EndlessWriteFuture()

Method Summary

Modifier and Type	Method	Description
IoWriteFuture	addListener(SshFutureListener<IoWriteFuture> listener)	Adds an event listener which is notified when this future is completed.
boolean	await(long timeoutMillis, CancelOption... options)	Wait for the asynchronous operation to complete with the specified timeout.
boolean	awaitUninterruptibly(long timeoutMillis, CancelOption... options)	Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.
java.lang.Throwable	getException()	Returns the cause of the failure.
java.lang.Object	getId()
boolean	isDone()
boolean	isWritten()
IoWriteFuture	removeListener(SshFutureListener<IoWriteFuture> listener)	Removes an existing event listener so it won't be notified when the future is completed.
IoWriteFuture	verify(long timeoutMillis, CancelOption... options)	Wait and verify that the operation was successful

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.common.future.VerifiableFuture

verify, verify, verify, verify, verify, verify, verify

Methods inherited from interface org.apache.sshd.common.future.WaitableFuture

await, await, await, await, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly

Field Detail

INSTANCE

public static final EndlessWriteFuture INSTANCE

Constructor Detail

EndlessWriteFuture

public EndlessWriteFuture()

Method Detail

verify

public IoWriteFuture verify(long timeoutMillis,
                            CancelOption... options)
                     throws java.io.IOException

Description copied from interface: VerifiableFuture

Wait and verify that the operation was successful

Specified by:

verify in interface VerifiableFuture<IoWriteFuture>

Parameters:

timeoutMillis - Wait timeout in milliseconds

options - Optional CancelOptions defining the behavior on time-out or interrupt; ignored if the future is not Cancellable.

Returns:

The (same) future instance

Throws:

java.io.IOException - If failed to verify successfully on time

isDone

public boolean isDone()

Specified by:

isDone in interface WaitableFuture

Returns:

true if the asynchronous operation is completed. Note: it is up to the caller to determine whether it was a successful or failed completion.

getId

public java.lang.Object getId()

Specified by:

getId in interface WaitableFuture

Returns:

Some identifier useful as toString() value

awaitUninterruptibly

public boolean awaitUninterruptibly(long timeoutMillis,
                                    CancelOption... options)

Description copied from interface: WaitableFuture

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

Specified by:

awaitUninterruptibly in interface WaitableFuture

Parameters:

timeoutMillis - Wait time in milliseconds

options - Optional CancelOptions defining the behavior on time-out; ignored if the future is not Cancellable.

Returns:

true if the operation is finished.

await

public boolean await(long timeoutMillis,
                     CancelOption... options)
              throws java.io.IOException

Description copied from interface: WaitableFuture

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

Specified by:

await in interface WaitableFuture

Parameters:

timeoutMillis - Wait time in milliseconds

options - Optional CancelOptions defining the behavior on time-out or interrupt; ignored if the future is not Cancellable.

Returns:

true if the operation is completed.

Throws:

java.io.IOException - if failed - specifically InterruptedIOException if waiting was interrupted

removeListener

public IoWriteFuture removeListener(SshFutureListener<IoWriteFuture> 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<IoWriteFuture>

Parameters:

listener - The SshFutureListener instance to remove

Returns:

The future instance

addListener

public IoWriteFuture addListener(SshFutureListener<IoWriteFuture> 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<IoWriteFuture>

Parameters:

listener - The SshFutureListener instance to add

Returns:

The future instance

isWritten

public boolean isWritten()

Specified by:

isWritten in interface IoWriteFuture

Returns:

true if the write operation is finished successfully.

getException

public java.lang.Throwable getException()

Description copied from interface: HasException

Returns the cause of the failure.

Specified by:

getException in interface HasException

Returns:

the Throwable of the failure, or null if not failed (yet).