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 Classes

Modifier and Type	Class	Description
static class	ChannelAsyncInputStream.IoReadFutureImpl

Nested classes/interfaces inherited from class AbstractCloseable

AbstractCloseable.State

Field Summary

Fields

Modifier and Type	Field	Description
private final Buffer	buffer
private final Channel	channelInstance
private ChannelAsyncInputStream.IoReadFutureImpl	pending
private final Object	readFutureId

Fields inherited from class AbstractCloseable

closeFuture, futureLock, state

Fields inherited from class AbstractLoggingBean

log

Constructor Summary

Constructors

Constructor	Description
ChannelAsyncInputStream(Channel channel)

Method Summary

Modifier and Type	Method	Description
protected CloseFuture	doCloseGracefully()
private void	doRead(boolean resume)
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 AbstractCloseable

addCloseFutureListener, builder, close, doCloseImmediately, getFutureLock, isClosed, isClosing, removeCloseFutureListener

Methods inherited from class 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 Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Closeable

addCloseFutureListener, close, close, isClosed, isClosing, isOpen, removeCloseFutureListener

Field Details

channelInstance

private final Channel channelInstance

buffer

private final Buffer buffer

readFutureId

private final Object readFutureId

pending

private ChannelAsyncInputStream.IoReadFutureImpl pending

Constructor Details

ChannelAsyncInputStream

public ChannelAsyncInputStream(Channel channel)

Method Details

getChannel

public Channel getChannel()

Specified by:

getChannel in interface ChannelHolder

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 interface IoInputStream

Parameters:

buf - the Buffer 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 class AbstractCloseable

doCloseGracefully

protected CloseFuture doCloseGracefully()

Overrides:

doCloseGracefully in class AbstractCloseable

doRead

private void doRead(boolean resume)

toString

public String toString()

Overrides:

toString in class Object