Package org.apache.sshd.client.future
Class DefaultConnectFuture
java.lang.Object
org.apache.sshd.common.util.logging.AbstractLoggingBean
org.apache.sshd.common.future.AbstractSshFuture<ConnectFuture>
org.apache.sshd.common.future.DefaultSshFuture<ConnectFuture>
org.apache.sshd.common.future.DefaultVerifiableSshFuture<ConnectFuture>
org.apache.sshd.common.future.DefaultCancellableSshFuture<ConnectFuture>
org.apache.sshd.client.future.DefaultConnectFuture
- All Implemented Interfaces:
ConnectFuture,ClientSessionHolder,Cancellable,SshFuture<ConnectFuture>,VerifiableFuture<ConnectFuture>,WaitableFuture,WithException,SessionContextHolder,SessionHolder<ClientSession>
public class DefaultConnectFuture
extends DefaultCancellableSshFuture<ConnectFuture>
implements ConnectFuture
A default implementation of
ConnectFuture.-
Field Summary
Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
log -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanvoidsetSession(ClientSession session) Sets the newly connected session and notifies all threads waiting for this future.verify(long timeout, CancelOption... options) Wait and verify that the operation was successfulMethods inherited from class org.apache.sshd.common.future.DefaultCancellableSshFuture
cancel, createCancellation, getCancellation, getException, isCanceled, setExceptionMethods inherited from class org.apache.sshd.common.future.DefaultSshFuture
addListener, await0, getNumRegisteredListeners, getValue, isDone, notifyListeners, onValueSet, removeListener, setValue, toStringMethods inherited from class org.apache.sshd.common.future.AbstractSshFuture
asListener, asT, await, awaitUninterruptibly, formatExceptionMessage, getId, notifyListener, verifyResultMethods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warnMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.sshd.common.future.Cancellable
cancel, getCancellation, isCanceledMethods inherited from interface org.apache.sshd.client.future.ConnectFuture
getClientSessionMethods inherited from interface org.apache.sshd.common.session.SessionHolder
getSessionContextMethods inherited from interface org.apache.sshd.common.future.SshFuture
addListener, removeListenerMethods inherited from interface org.apache.sshd.common.future.VerifiableFuture
verify, verify, verifyMethods inherited from interface org.apache.sshd.common.future.WaitableFuture
await, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, getId, isDoneMethods inherited from interface org.apache.sshd.common.future.WithException
getException, setException
-
Constructor Details
-
DefaultConnectFuture
-
-
Method Details
-
verify
Wait and verify that the operation was successfulIf no
CancelOptions are given, this behaves as ifCancelOption.CANCEL_ON_TIMEOUTandCancelOption.CANCEL_ON_INTERRUPTwere set.- Specified by:
verifyin interfaceVerifiableFuture<ConnectFuture>- Parameters:
timeout- Wait timeout in millisecondsoptions- OptionalCancelOptions defining the behavior on time-out or interrupt; ignored if the future is notCancellable.- Returns:
- The (same) future instance
- Throws:
IOException- If failed to verify successfully on time
-
getSession
- Specified by:
getSessionin interfaceSessionHolder<ClientSession>
-
isConnected
public boolean isConnected()- Specified by:
isConnectedin interfaceConnectFuture- Returns:
trueif the connect operation is finished successfully.
-
setSession
Description copied from interface:ConnectFutureSets 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.- Specified by:
setSessionin interfaceConnectFuture- Parameters:
session- TheClientSession
-