Top Constructors Methods
org.apache.sshd.common.io

public abstract Class AbstractIoWriteFuture

extends DefaultVerifiableSshFuture<IoWriteFuture>
implements IoWriteFuture
Class Inheritance
All Implemented Interfaces
org.apache.sshd.common.io.IoWriteFuture, org.apache.sshd.common.future.VerifiableFuture, org.apache.sshd.common.future.SshFuture, org.apache.sshd.common.future.WaitableFuture, org.apache.sshd.common.future.HasException
Imports
java.io.IOException, java.util.Objects, org.apache.sshd.common.SshException, org.apache.sshd.common.future.CancelOption, .DefaultVerifiableSshFuture
Author
Apache MINA SSHD Project

Constructor Summary

AccessConstructor and Description
protected
AbstractIoWriteFuture(Object id, Object lock)

Method Summary

Modifier and TypeMethod and Description
public static IoWriteFuture
fulfilled(Object id, Object value)

public Throwable
getException()

Implements org.apache.sshd.common.future.HasException.getException.

Returns the cause of the failure.

public boolean
isWritten()

Implements org.apache.sshd.common.io.IoWriteFuture.isWritten.

public IoWriteFuture
verify(long
Wait timeout in milliseconds
timeout, CancelOption...
Optional CancelOptions defining the behavior on time-out or interrupt; ignored if the future is not Cancellable.
options)

Implements org.apache.sshd.common.future.VerifiableFuture.verify.

Wait and verify that the operation was successful

Constructor Detail

AbstractIoWriteFutureback to summary
protected AbstractIoWriteFuture(Object id, Object lock)

Method Detail

fulfilledback to summary
public static IoWriteFuture fulfilled(Object id, Object value)
getExceptionback to summary
public Throwable getException()

Implements org.apache.sshd.common.future.HasException.getException.

Doc from org.apache.sshd.common.future.HasException.getException.

Returns the cause of the failure.

Returns:Throwable

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

Annotations
@Override
isWrittenback to summary
public boolean isWritten()

Implements org.apache.sshd.common.io.IoWriteFuture.isWritten.

Returns:boolean

Doc from org.apache.sshd.common.io.IoWriteFuture.isWritten.

true if the write operation is finished successfully.

Annotations
@Override
verifyback to summary
public IoWriteFuture verify(long timeout, CancelOption... options) throws IOException

Implements org.apache.sshd.common.future.VerifiableFuture.verify.

Doc from org.apache.sshd.common.future.VerifiableFuture.verify.

Wait and verify that the operation was successful

Parameters
timeout:long

Wait timeout in milliseconds

options:CancelOption[]

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

Returns:IoWriteFuture

The (same) future instance

Annotations
@Override
Exceptions
IOException:
If failed to verify successfully on time