Package org.apache.sshd.common.io
Class DefaultIoConnectFuture
- 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<IoConnectFuture>
-
- org.apache.sshd.common.io.DefaultIoConnectFuture
-
- All Implemented Interfaces:
Cancellable
,HasException
,SshFuture<IoConnectFuture>
,VerifiableFuture<IoConnectFuture>
,WaitableFuture
,WithException
,IoConnectFuture
public class DefaultIoConnectFuture extends DefaultCancellableSshFuture<IoConnectFuture> implements IoConnectFuture
A default implementation of anIoConnectFuture
.
-
-
Field Summary
-
Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
log
-
-
Constructor Summary
Constructors Constructor Description DefaultIoConnectFuture(java.lang.Object id, java.lang.Object lock)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IoSession
getSession()
boolean
isConnected()
void
setSession(IoSession session)
Sets the newly connected session and notifies all threads waiting for this future.IoConnectFuture
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
-
getSession
public IoSession getSession()
- Specified by:
getSession
in interfaceIoConnectFuture
- Returns:
- The current
IoSession
- may benull
if connect operation not finished yet or attempt has failed - See Also:
HasException.getException()
-
isConnected
public boolean isConnected()
- Specified by:
isConnected
in interfaceIoConnectFuture
- Returns:
- true if the connect operation is finished successfully.
-
setSession
public void setSession(IoSession session)
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
public IoConnectFuture 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<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:
java.io.IOException
- If failed to verify successfully on time
-
-