Package org.apache.sshd.common.channel

Class ChannelPipedInputStream

java.lang.Object

java.io.InputStream

org.apache.sshd.common.channel.ChannelPipedInputStream

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, ChannelPipedSink

public class ChannelPipedInputStream
extends InputStream
implements ChannelPipedSink

TODO Add javadoc

Author:

Apache MINA SSHD Project

Constructor Summary

Constructors

Constructor	Description
ChannelPipedInputStream(LocalWindow localWindow, long windowTimeout)
ChannelPipedInputStream(LocalWindow localWindow, Duration windowTimeout)
ChannelPipedInputStream(PropertyResolver resolver, LocalWindow localWindow)

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
void	eof()	Signal end of writing to the sink
long	getTimeout()
boolean	isOpen()
int	read()
int	read(byte[] b, int off, int len)
void	receive(byte[] bytes, int off, int len)
void	setTimeout(long timeout)

Methods inherited from class java.io.InputStream

mark, markSupported, nullInputStream, read, readAllBytes, readNBytes, readNBytes, reset, skip, transferTo

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelPipedInputStream

public ChannelPipedInputStream(PropertyResolver resolver,
                               LocalWindow localWindow)

ChannelPipedInputStream

public ChannelPipedInputStream(LocalWindow localWindow,
                               Duration windowTimeout)

ChannelPipedInputStream

public ChannelPipedInputStream(LocalWindow localWindow,
                               long windowTimeout)

Method Detail

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

setTimeout

public void setTimeout(long timeout)

getTimeout

public long getTimeout()

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

eof

public void eof()

Description copied from interface: ChannelPipedSink

Signal end of writing to the sink

Specified by:

eof in interface ChannelPipedSink

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException

receive

public void receive(byte[] bytes,
                    int off,
                    int len)
             throws IOException

Specified by:

receive in interface ChannelPipedSink

Parameters:

bytes - Bytes to be sent to the sink

off - Offset in buffer

len - Number of bytes

Throws:

IOException - If failed to send the data