Apache Mina SSHD 2.15.0 · org.apache.sshd.common.channel.ChannelPipedInputStream

Modifier and Type	Field and Description
private final byte[]	b
private Buffer	buffer
private final Condition	dataAvailable
private final LocalWindow	localWindow
private final Lock	lock
private final AtomicBoolean	open
private long	timeout
private final AtomicBoolean	writerClosed `ChannelPipedOutputStream` is already closed and so we will not receive additional data.

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

Method Summary

Modifier and Type	Method and Description
public int	available() Overrides java.io.InputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected.
public void	close() Overrides java.io.InputStream.close. Implements java.nio.channels.Channel.close, java.io.Closeable.close. Closes this channel.
public void	eof() Implements org.apache.sshd.common.channel.ChannelPipedSink.eof. Signal end of writing to the sink
public long	getTimeout()
public boolean	isOpen() Implements java.nio.channels.Channel.isOpen. Tells whether or not this channel is open.
public int	read() Implements abstract java.io.InputStream.read. Reads the next byte of data from the input stream.
public int	read(byte[] the buffer into which the data is read. b, int the start offset in array `b` at which the data is written. off, int the maximum number of bytes to read. len) Overrides java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes.
public void	receive(byte[] Bytes to be sent to the sink bytes, int Offset in buffer off, int Number of bytes len) Implements org.apache.sshd.common.channel.ChannelPipedSink.receive.
public void	setTimeout(long timeout)

Inherited from java.io.InputStream:: mark markSupported nullInputStream read readAllBytes readNBytes readNBytes reset skip skipNBytes transferTo

b	back to summary
private final byte[] b

buffer	back to summary
private Buffer buffer

dataAvailable	back to summary
private final Condition dataAvailable

localWindow	back to summary
private final LocalWindow localWindow

lock	back to summary
private final Lock lock

open	back to summary
private final AtomicBoolean open

timeout	back to summary
private long timeout

writerClosed	back to summary
private final AtomicBoolean writerClosed `ChannelPipedOutputStream` is already closed and so we will not receive additional data. This is different from the `isOpen()`, which indicates that the reader of this `InputStream` will not be reading data any more.

ChannelPipedInputStream	back to summary
public ChannelPipedInputStream(PropertyResolver resolver, LocalWindow localWindow)

ChannelPipedInputStream	back to summary
public ChannelPipedInputStream(LocalWindow localWindow, Duration windowTimeout)

ChannelPipedInputStream	back to summary
public ChannelPipedInputStream(LocalWindow localWindow, long windowTimeout)

Method Detail

available back to summary

available	back to summary
public int available() throws IOException Overrides java.io.InputStream.available. Doc from java.io.InputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected. The read might be on the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes. Note that while some implementations of `InputStream` will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream. A subclass's implementation of this method may choose to throw an `IOException` if this input stream has been closed by invoking the `close()` method. Returns:int an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or `0` when it reaches the end of the input stream. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int available() throws IOException

Overrides java.io.InputStream.available.

Doc from java.io.InputStream.available.

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected. The read might be on the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

Note that while some implementations of InputStream will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream.

A subclass's implementation of this method may choose to throw an IOException if this input stream has been closed by invoking the close() method.

Returns:int

an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or 0 when it reaches the end of the input stream.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

close back to summary

close	back to summary
public void close() throws IOException Overrides java.io.InputStream.close. Implements java.nio.channels.Channel.close, java.io.Closeable.close. Doc from java.nio.channels.Channel.close. Closes this channel. After a channel is closed, any further attempt to invoke I/O operations upon it will cause a `ClosedChannelException` to be thrown. If this channel is already closed then invoking this method has no effect. This method may be invoked at any time. If some other thread has already invoked it, however, then another invocation will block until the first invocation is complete, after which it will return without effect. Annotations @Override Exceptions IOException: If an I/O error occurs

public void close() throws IOException

Overrides java.io.InputStream.close.

Implements java.nio.channels.Channel.close, java.io.Closeable.close.

Doc from java.nio.channels.Channel.close.

Closes this channel.

After a channel is closed, any further attempt to invoke I/O operations upon it will cause a ClosedChannelException to be thrown.

If this channel is already closed then invoking this method has no effect.

This method may be invoked at any time. If some other thread has already invoked it, however, then another invocation will block until the first invocation is complete, after which it will return without effect.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

eof	back to summary
public void eof() Implements org.apache.sshd.common.channel.ChannelPipedSink.eof. Doc from org.apache.sshd.common.channel.ChannelPipedSink.eof. Signal end of writing to the sink Annotations @Override

eof

back to summary

public void eof()

Implements org.apache.sshd.common.channel.ChannelPipedSink.eof.

Doc from org.apache.sshd.common.channel.ChannelPipedSink.eof.

Signal end of writing to the sink

Annotations

@Override

getTimeout	back to summary
public long getTimeout()

isOpen back to summary

isOpen	back to summary
public boolean isOpen() Implements java.nio.channels.Channel.isOpen. Doc from java.nio.channels.Channel.isOpen. Tells whether or not this channel is open. Returns:boolean `true` if, and only if, this channel is open Annotations @Override

public boolean isOpen()

Implements java.nio.channels.Channel.isOpen.

Doc from java.nio.channels.Channel.isOpen.

Tells whether or not this channel is open.

Returns:boolean

true if, and only if, this channel is open

Annotations

@Override

read back to summary

read	back to summary
public int read() throws IOException Implements abstract java.io.InputStream.read. Doc from java.io.InputStream.read. Reads the next byte of data from the input stream. The value byte is returned as an `int` in the range `0` to `255`. If no byte is available because the end of the stream has been reached, the value `-1` is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown. Returns:int the next byte of data, or `-1` if the end of the stream is reached. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int read() throws IOException

Implements abstract java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Returns:int

the next byte of data, or -1 if the end of the stream is reached.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read(byte[] b, int off, int len) throws IOException Overrides java.io.InputStream.read. Doc from java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes. An attempt is made to read as many as `len` bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown. If `len` is zero, then no bytes are read and `0` is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value `-1` is returned; otherwise, at least one byte is read and stored into `b`. The first byte read is stored into element `b[off]`, the next one into `b[off+1]`, and so on. The number of bytes read is, at most, equal to `len`. Let k be the number of bytes actually read; these bytes will be stored in elements `b[off]` through `b[off+`k`-1]`, leaving elements `b[off+`k`]` through `b[off+len-1]` unaffected. In every case, elements `b[0]` through `b[off-1]` and elements `b[off+len]` through `b[b.length-1]` are unaffected. Parameters b:byte[] the buffer into which the data is read. off:int the start offset in array `b` at which the data is written. len:int the maximum number of bytes to read. Returns:int the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the stream has been reached. Annotations @Override Exceptions IOException: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

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

Overrides java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.

In every case, elements b[0] through b[off-1] and elements b[off+len] through b[b.length-1] are unaffected.

Parameters

b:byte[]: the buffer into which the data is read.
off:int: the start offset in array b at which the data is written.
len:int: the maximum number of bytes to read.

Returns:int

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Annotations

@Override

Exceptions

IOException:: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

receive	back to summary
public void receive(byte[] bytes, int off, int len) throws IOException Implements org.apache.sshd.common.channel.ChannelPipedSink.receive. Parameters bytes:byte[] Doc from org.apache.sshd.common.channel.ChannelPipedSink.receive. Bytes to be sent to the sink off:int Doc from org.apache.sshd.common.channel.ChannelPipedSink.receive. Offset in buffer len:int Doc from org.apache.sshd.common.channel.ChannelPipedSink.receive. Number of bytes Annotations @Override Exceptions IOException: Doc from org.apache.sshd.common.channel.ChannelPipedSink.receive. If failed to send the data

receive

back to summary

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

Implements org.apache.sshd.common.channel.ChannelPipedSink.receive.

Parameters

bytes:byte[]

Doc from org.apache.sshd.common.channel.ChannelPipedSink.receive.

Bytes to be sent to the sink

off:int

Doc from org.apache.sshd.common.channel.ChannelPipedSink.receive.

Offset in buffer

len:int