Package org.apache.sshd.common.channel
Class ChannelAsyncInputStream
java.lang.Object
org.apache.sshd.common.util.logging.AbstractLoggingBean
org.apache.sshd.common.util.closeable.IoBaseCloseable
org.apache.sshd.common.util.closeable.AbstractCloseable
org.apache.sshd.common.channel.ChannelAsyncInputStream
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Channel
,ChannelHolder
,Closeable
,IoInputStream
public class ChannelAsyncInputStream
extends AbstractCloseable
implements IoInputStream, ChannelHolder
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable
AbstractCloseable.State
-
Field Summary
FieldsFields inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable
closeFuture, futureLock, state
Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
log
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected CloseFuture
private void
doRead
(boolean resume) protected void
preClose()
preClose is guaranteed to be called before doCloseGracefully or doCloseImmediately.NOTE: the buffer must not be touched until the returned read future is completed.toString()
void
Methods inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable
addCloseFutureListener, builder, close, doCloseImmediately, getFutureLock, isClosed, isClosing, removeCloseFutureListener
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.Closeable
addCloseFutureListener, close, close, isClosed, isClosing, isOpen, removeCloseFutureListener
-
Field Details
-
channelInstance
-
buffer
-
readFutureId
-
pending
-
-
Constructor Details
-
ChannelAsyncInputStream
-
-
Method Details
-
getChannel
- Specified by:
getChannel
in interfaceChannelHolder
- Returns:
- The associated
Channel
instance
-
write
- Throws:
IOException
-
read
Description copied from interface:IoInputStream
NOTE: the buffer must not be touched until the returned read future is completed.- Specified by:
read
in interfaceIoInputStream
- Parameters:
buf
- theBuffer
to use- Returns:
- The
IoReadFuture
for the operation
-
preClose
protected void preClose()Description copied from class:AbstractCloseable
preClose is guaranteed to be called before doCloseGracefully or doCloseImmediately. When preClose() is called, isClosing() == true- Overrides:
preClose
in classAbstractCloseable
-
doCloseGracefully
- Overrides:
doCloseGracefully
in classAbstractCloseable
-
doRead
private void doRead(boolean resume) -
toString
-