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

public class ChannelAsyncInputStream
extends AbstractCloseable
implements IoInputStream, ChannelHolder

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested Classes

Modifier and Type	Class and 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, lock, 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 and Description
ChannelAsyncInputStream(Channel channel)

Method Summary

Modifier and Type	Method and 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, 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, close, getMaxCloseWaitTime, isClosed, isClosing, isOpen, removeCloseFutureListener

Constructor Detail

ChannelAsyncInputStream

public ChannelAsyncInputStream(Channel channel)

Method Detail

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

toString

public String toString()

Overrides:

toString in class Object