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<IoReadFuture>
org.apache.sshd.common.future.DefaultSshFuture<IoReadFuture>
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
FieldsFields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
log -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionRetrieves the buffer data was read into.Returns the cause of the read failure.intgetRead()Retrieves the number of bytes read.verify(long timeoutMillis, CancelOption... options) Wait and verify that the operation was successfulMethods inherited from class org.apache.sshd.common.future.DefaultSshFuture
addListener, await0, createCancellation, getNumRegisteredListeners, getValue, isDone, notifyListeners, onValueSet, removeListener, setValue, toStringMethods inherited from class org.apache.sshd.common.future.AbstractSshFuture
asListener, asT, await, awaitUninterruptibly, formatExceptionMessage, getId, notifyListener, verifyResultMethods 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, warnMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.sshd.common.future.SshFuture
addListener, removeListenerMethods inherited from interface org.apache.sshd.common.future.VerifiableFuture
verify, verify, verifyMethods inherited from interface org.apache.sshd.common.future.WaitableFuture
await, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, getId, isDone
-
Field Details
-
buffer
-
-
Constructor Details
-
IoReadFutureImpl
-
-
Method Details
-
getBuffer
Description copied from interface:IoReadFutureRetrieves the buffer data was read into.- Specified by:
getBufferin interfaceIoReadFuture- Returns:
- the buffer,
nullifWaitableFuture.isDone()== false
-
verify
Description copied from interface:VerifiableFutureWait and verify that the operation was successful- Specified by:
verifyin interfaceVerifiableFuture<IoReadFuture>- Parameters:
timeoutMillis- Wait timeout in millisecondsoptions- OptionalCancelOptions 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
-
getRead
public int getRead()Description copied from interface:IoReadFutureRetrieves the number of bytes read.- Specified by:
getReadin 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
Description copied from interface:IoReadFutureReturns the cause of the read failure. AnEOFExceptionindicates that nothing was read because the source of the read is exhausted.- Specified by:
getExceptionin interfaceIoReadFuture- Returns:
nullif the read operation is not finished yet, or if the read attempt is successful (useWaitableFuture.isDone()to distinguish between the two).
-