Package org.apache.sshd.common.channel
Class ChannelAsyncInputStream.IoReadFutureImpl
- 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<IoReadFuture>
-
- org.apache.sshd.common.channel.ChannelAsyncInputStream.IoReadFutureImpl
-
- All Implemented Interfaces:
SshFuture<IoReadFuture>
,VerifiableFuture<IoReadFuture>
,WaitableFuture
,IoReadFuture
- Enclosing class:
- ChannelAsyncInputStream
public static class ChannelAsyncInputStream.IoReadFutureImpl extends DefaultVerifiableSshFuture<IoReadFuture> implements IoReadFuture
-
-
Field Summary
-
Fields inherited from class org.apache.sshd.common.future.AbstractSshFuture
CANCELED, debugEnabled, traceEnabled
-
Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
log
-
-
Constructor Summary
Constructors Constructor Description IoReadFutureImpl(Object id, Buffer buffer)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Buffer
getBuffer()
Throwable
getException()
Returns the cause of the read failure.int
getRead()
IoReadFuture
verify(long timeoutMillis)
Wait and verify that the operation was successful-
Methods inherited from class org.apache.sshd.common.future.DefaultSshFuture
addListener, await0, cancel, getNumRegisteredListeners, getValue, isCanceled, isDone, notifyListeners, 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
getSimplifiedLogger
-
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.SshFuture
addListener, removeListener
-
Methods inherited from interface org.apache.sshd.common.future.VerifiableFuture
verify, verify
-
Methods inherited from interface org.apache.sshd.common.future.WaitableFuture
await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, getId, isDone
-
-
-
-
Method Detail
-
getBuffer
public Buffer getBuffer()
- Specified by:
getBuffer
in interfaceIoReadFuture
-
verify
public IoReadFuture verify(long timeoutMillis) throws IOException
Description copied from interface:VerifiableFuture
Wait and verify that the operation was successful- Specified by:
verify
in interfaceVerifiableFuture<IoReadFuture>
- Parameters:
timeoutMillis
- Wait timeout in milliseconds- Returns:
- The (same) future instance
- Throws:
IOException
- If failed to verify successfully on time
-
getRead
public int getRead()
- Specified by:
getRead
in interfaceIoReadFuture
-
getException
public Throwable getException()
Description copied from interface:IoReadFuture
Returns the cause of the read failure.- Specified by:
getException
in interfaceIoReadFuture
- Returns:
null
if the read operation is not finished yet, or if the read attempt is successful (useWaitableFuture.isDone()
to distinguish between the two).
-
-