Package org.apache.sshd.client.future
Class DefaultOpenFuture
- java.lang.Object
-
- org.apache.sshd.common.util.logging.AbstractLoggingBean
-
- org.apache.sshd.common.future.AbstractSshFuture<T>
-
- org.apache.sshd.common.future.DefaultSshFuture<T>
-
- org.apache.sshd.common.future.DefaultVerifiableSshFuture<T>
-
- org.apache.sshd.common.future.DefaultCancellableSshFuture<OpenFuture>
-
- org.apache.sshd.client.future.DefaultOpenFuture
-
- All Implemented Interfaces:
OpenFuture
,Cancellable
,HasException
,SshFuture<OpenFuture>
,VerifiableFuture<OpenFuture>
,WaitableFuture
,WithException
public class DefaultOpenFuture extends DefaultCancellableSshFuture<OpenFuture> implements OpenFuture
A default implementation ofOpenFuture
.
-
-
Field Summary
-
Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
log
-
-
Constructor Summary
Constructors Constructor Description DefaultOpenFuture(java.lang.Object id, java.lang.Object lock)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
isOpened()
void
setOpened()
Sets the newly connected session and notifies all threads waiting for this future.OpenFuture
verify(long timeoutMillis, CancelOption... options)
Wait and verify that the operation was successful-
Methods inherited from class org.apache.sshd.common.future.DefaultCancellableSshFuture
cancel, createCancellation, getCancellation, getException, isCanceled, setException
-
Methods inherited from class org.apache.sshd.common.future.DefaultSshFuture
addListener, await0, getNumRegisteredListeners, getValue, isDone, notifyListeners, onValueSet, removeListener, setValue, toString
-
Methods inherited from class org.apache.sshd.common.future.AbstractSshFuture
asListener, asT, await, awaitUninterruptibly, formatExceptionMessage, getId, notifyListener, verifyResult
-
Methods 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, warn
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.sshd.common.future.Cancellable
cancel, getCancellation, isCanceled
-
Methods inherited from interface org.apache.sshd.common.future.HasException
getException
-
Methods inherited from interface org.apache.sshd.common.future.SshFuture
addListener, removeListener
-
Methods inherited from interface org.apache.sshd.common.future.VerifiableFuture
verify, verify, verify, verify, verify, verify, verify
-
Methods inherited from interface org.apache.sshd.common.future.WaitableFuture
await, await, await, await, await, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, getId, isDone
-
Methods inherited from interface org.apache.sshd.common.future.WithException
setException
-
-
-
-
Method Detail
-
verify
public OpenFuture verify(long timeoutMillis, CancelOption... options) throws java.io.IOException
Description copied from interface:VerifiableFuture
Wait and verify that the operation was successful- Specified by:
verify
in interfaceVerifiableFuture<OpenFuture>
- Parameters:
timeoutMillis
- Wait timeout in millisecondsoptions
- OptionalCancelOption
s defining the behavior on time-out or interrupt; ignored if the future is notCancellable
.- Returns:
- The (same) future instance
- Throws:
java.io.IOException
- If failed to verify successfully on time
-
isOpened
public boolean isOpened()
- Specified by:
isOpened
in interfaceOpenFuture
- Returns:
true
if the connect operation is finished successfully.
-
setOpened
public void setOpened()
Description copied from interface:OpenFuture
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.- Specified by:
setOpened
in interfaceOpenFuture
-
-