Top Description Constructors Methods
org.apache.sshd.client.future

public Class DefaultOpenFuture

extends DefaultCancellableSshFuture<OpenFuture>
implements OpenFuture
Class Inheritance
All Implemented Interfaces
org.apache.sshd.client.future.OpenFuture, org.apache.sshd.common.future.Cancellable, org.apache.sshd.common.future.WithException, org.apache.sshd.common.future.HasException, 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, org.apache.sshd.common.future.CancelOption, .DefaultCancellableSshFuture
A default implementation of OpenFuture.
Author
Apache MINA SSHD Project

Constructor Summary

AccessConstructor and Description
public
DefaultOpenFuture(Object id, Object lock)

Method Summary

Modifier and TypeMethod and Description
public boolean
isOpened()

Implements org.apache.sshd.client.future.OpenFuture.isOpened.

public void
setOpened()

Implements org.apache.sshd.client.future.OpenFuture.setOpened.

Sets the newly connected session and notifies all threads waiting for this future.

public OpenFuture
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

Inherited from org.apache.sshd.common.future.DefaultCancellableSshFuture:
cancelcreateCancellationgetCancellationgetExceptionisCanceledsetException

Constructor Detail

DefaultOpenFutureback to summary
public DefaultOpenFuture(Object id, Object lock)

Method Detail

isOpenedback to summary
public boolean isOpened()

Implements org.apache.sshd.client.future.OpenFuture.isOpened.

Returns:boolean

Doc from org.apache.sshd.client.future.OpenFuture.isOpened.

true if the connect operation is finished successfully.

Annotations
@Override
setOpenedback to summary
public void setOpened()

Implements org.apache.sshd.client.future.OpenFuture.setOpened.

Doc from org.apache.sshd.client.future.OpenFuture.setOpened.

Sets the newly connected session and notifies all threads waiting for this future. This method is invoked by SSHD internally. Please do not call this method directly.

Annotations
@Override
verifyback to summary
public OpenFuture 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:OpenFuture

The (same) future instance

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