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 Modifier and Type Field Description (package private) Buffer
buffer
-
Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
log
-
-
Constructor Summary
Constructors Constructor Description IoReadFutureImpl(java.lang.Object id, Buffer buffer)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Buffer
getBuffer()
Retrieves the buffer data was read into.java.lang.Throwable
getException()
Returns the cause of the read failure.int
getRead()
Retrieves the number of bytes read.IoReadFuture
verify(long timeoutMillis, CancelOption... options)
Wait and verify that the operation was successful-
Methods inherited from class org.apache.sshd.common.future.DefaultSshFuture
addListener, await0, createCancellation, 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.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
-
-
-
-
Field Detail
-
buffer
final Buffer buffer
-
-
Constructor Detail
-
IoReadFutureImpl
public IoReadFutureImpl(java.lang.Object id, Buffer buffer)
-
-
Method Detail
-
getBuffer
public Buffer getBuffer()
Description copied from interface:IoReadFuture
Retrieves the buffer data was read into.- Specified by:
getBuffer
in interfaceIoReadFuture
- Returns:
- the buffer,
null
ifWaitableFuture.isDone()
== false
-
verify
public IoReadFuture 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<IoReadFuture>
- 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
-
getRead
public int getRead()
Description copied from interface:IoReadFuture
Retrieves the number of bytes read.- Specified by:
getRead
in interfaceIoReadFuture
- Returns:
- The number of bytes read, or -1 if the source of the read has been exhausted (is at EOF), or zero if the
read is not done yet (
WaitableFuture.isDone()
== false
)
-
getException
public java.lang.Throwable getException()
Description copied from interface:IoReadFuture
Returns the cause of the read failure. AnEOFException
indicates that nothing was read because the source of the read is exhausted.- 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).
-
-