org.apache.sshd.client.future

public Interface ConnectFuture

Known Direct Implementers: org.apache.sshd.client.future.DefaultConnectFuture
Imports: org.apache.sshd.client.session.ClientSession, .ClientSessionHolder, org.apache.sshd.common.future.Cancellable, .SshFuture, .VerifiableFuture, org.apache.sshd.common.session.SessionHolder

An SshFuture for asynchronous connections requests.

Author: Apache MINA SSHD Project

Method Summary

Modifier and Type	Method and Description
public default ClientSession	getClientSession() Implements org.apache.sshd.client.session.ClientSessionHolder.getClientSession.
public boolean	Returns: `true` if the connect operation is finished successfully. isConnected()
public void	setSession(ClientSession The `ClientSession` session) Sets the newly connected session and notifies all threads waiting for this future.

Inherited from org.apache.sshd.common.future.Cancellable:: cancel getCancellation isCanceled
Inherited from org.apache.sshd.common.future.SshFuture:: addListener removeListener
Inherited from org.apache.sshd.common.future.VerifiableFuture:: verify verify verify verify verify verify verify verify
Inherited from org.apache.sshd.common.session.SessionHolder:: getSession getSessionContext

Method Detail

getClientSession back to summary

getClientSession	back to summary
public default ClientSession getClientSession() Implements org.apache.sshd.client.session.ClientSessionHolder.getClientSession. Returns:ClientSession Doc from org.apache.sshd.client.session.ClientSessionHolder.getClientSession. The underlying `ClientSession` used Annotations @Override

public default ClientSession getClientSession()

Implements org.apache.sshd.client.session.ClientSessionHolder.getClientSession.

Returns:ClientSession

Doc from org.apache.sshd.client.session.ClientSessionHolder.getClientSession.

The underlying ClientSession used

Annotations

@Override

isConnected	back to summary
public boolean isConnected() Returns:boolean `true` if the connect operation is finished successfully.

setSession back to summary

setSession	back to summary
public void setSession(ClientSession session) 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. Parameters session:ClientSession The `ClientSession`

public void setSession(ClientSession session)

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.

Parameters

session:ClientSession: The ClientSession