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

public Class DefaultKeyExchangeFuture

extends DefaultVerifiableSshFuture<KeyExchangeFuture>
implements KeyExchangeFuture
Class Inheritance
All Implemented Interfaces
org.apache.sshd.common.future.KeyExchangeFuture, org.apache.sshd.common.future.VerifiableFuture, org.apache.sshd.common.future.SshFuture, org.apache.sshd.common.future.WaitableFuture
Imports
java.io.IOException, org.apache.sshd.common.SshException

Author
Apache MINA SSHD Project

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Throwable
getException()

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

Returns the cause of the exchange failure.

public KeyExchangeFuture
verify(long
Wait timeout in milliseconds
timeoutMillis
,
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

DefaultKeyExchangeFutureback to summary
public DefaultKeyExchangeFuture(Object id, Object lock)

Method Detail

getExceptionback to summary
public Throwable getException()

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

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

Returns the cause of the exchange failure.

Returns:Throwable

null if the exchange operation is not finished yet, or if the connection attempt is successful (use isDone() to distinguish between the two).

Annotations
@Override
verifyback to summary
public KeyExchangeFuture verify(long timeoutMillis, 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
timeoutMillis: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:KeyExchangeFuture

The (same) future instance

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