Package org.apache.sshd.client.future
Class DefaultOpenFuture
java.lang.Object
org.apache.sshd.common.util.logging.AbstractLoggingBean
org.apache.sshd.common.future.AbstractSshFuture<OpenFuture>
org.apache.sshd.common.future.DefaultSshFuture<OpenFuture>
org.apache.sshd.common.future.DefaultVerifiableSshFuture<OpenFuture>
org.apache.sshd.common.future.DefaultCancellableSshFuture<OpenFuture>
org.apache.sshd.client.future.DefaultOpenFuture
- All Implemented Interfaces:
OpenFuture,Cancellable,SshFuture<OpenFuture>,VerifiableFuture<OpenFuture>,WaitableFuture,WithException
public class DefaultOpenFuture
extends DefaultCancellableSshFuture<OpenFuture>
implements OpenFuture
A default implementation of
OpenFuture.-
Field Summary
Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
log -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanisOpened()voidSets the newly connected session and notifies all threads waiting for this future.verify(long timeoutMillis, 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.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
-
DefaultOpenFuture
-
-
Method Details
-
verify
Description copied from interface:VerifiableFutureWait and verify that the operation was successful- Specified by:
verifyin interfaceVerifiableFuture<OpenFuture>- Parameters:
timeoutMillis- 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
-
isOpened
public boolean isOpened()- Specified by:
isOpenedin interfaceOpenFuture- Returns:
trueif the connect operation is finished successfully.
-
setOpened
public void setOpened()Description copied from interface:OpenFutureSets 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:
setOpenedin interfaceOpenFuture
-