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
- Author:
- Apache MINA SSHD Project
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ChannelAsyncInputStream.IoReadFutureImpl
-
Nested classes/interfaces inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable
AbstractCloseable.State
-
-
Field Summary
-
Fields 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
-
Fields inherited from interface org.apache.sshd.common.Closeable
CLOSE_WAIT_TIMEOUT, DEFAULT_CLOSE_WAIT_TIMEOUT
-
-
Constructor Summary
Constructors Constructor Description ChannelAsyncInputStream(Channel channel)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected CloseFuture
doCloseGracefully()
Channel
getChannel()
protected void
preClose()
preClose is guaranteed to be called before doCloseGracefully or doCloseImmediately.IoReadFuture
read(Buffer buf)
NOTE: the buffer must not be touched until the returned read future is completed.String
toString()
void
write(Readable src)
-
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
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.Closeable
addCloseFutureListener, close, close, isClosed, isClosing, isOpen, removeCloseFutureListener
-
-
-
-
Constructor Detail
-
ChannelAsyncInputStream
public ChannelAsyncInputStream(Channel channel)
-
-
Method Detail
-
getChannel
public Channel getChannel()
- Specified by:
getChannel
in interfaceChannelHolder
- Returns:
- The associated
Channel
instance
-
write
public void write(Readable src) throws IOException
- Throws:
IOException
-
read
public IoReadFuture read(Buffer buf)
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
protected CloseFuture doCloseGracefully()
- Overrides:
doCloseGracefully
in classAbstractCloseable
-
-