Package org.apache.sshd.common.io
Class DefaultIoConnectFuture
java.lang.Object
org.apache.sshd.common.util.logging.AbstractLoggingBean
org.apache.sshd.common.future.AbstractSshFuture<IoConnectFuture>
org.apache.sshd.common.future.DefaultSshFuture<IoConnectFuture>
org.apache.sshd.common.future.DefaultVerifiableSshFuture<IoConnectFuture>
org.apache.sshd.common.future.DefaultCancellableSshFuture<IoConnectFuture>
org.apache.sshd.common.io.DefaultIoConnectFuture
- All Implemented Interfaces:
Cancellable
,SshFuture<IoConnectFuture>
,VerifiableFuture<IoConnectFuture>
,WaitableFuture
,WithException
,IoConnectFuture
public class DefaultIoConnectFuture
extends DefaultCancellableSshFuture<IoConnectFuture>
implements IoConnectFuture
A default implementation of an
IoConnectFuture
.-
Field Summary
Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
log
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
void
setSession
(IoSession session) Sets 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, 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.SshFuture
addListener, removeListener
Methods inherited from interface org.apache.sshd.common.future.VerifiableFuture
verify, verify, verify
Methods inherited from interface org.apache.sshd.common.future.WaitableFuture
await, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, getId, isDone
Methods inherited from interface org.apache.sshd.common.future.WithException
getException, setException
-
Constructor Details
-
DefaultIoConnectFuture
-
-
Method Details
-
getSession
- Specified by:
getSession
in interfaceIoConnectFuture
- Returns:
- The current
IoSession
- may benull
if connect operation not finished yet or attempt has failed - See Also:
-
isConnected
public boolean isConnected()- Specified by:
isConnected
in interfaceIoConnectFuture
- Returns:
- true if the connect operation is finished successfully.
-
setSession
Description copied from interface:IoConnectFuture
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:
setSession
in interfaceIoConnectFuture
- Parameters:
session
- The connectedIoSession
-
verify
Description copied from interface:VerifiableFuture
Wait and verify that the operation was successful- Specified by:
verify
in interfaceVerifiableFuture<IoConnectFuture>
- 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:
IOException
- If failed to verify successfully on time
-