java.io

Класс PipedInputStream

java.lang. Объект

java.io. InputStream

java.io. PipedInputStream

Все Реализованные Интерфейсы:

Closeable, AutoCloseable

public class PipedInputStream
extends InputStream

Переданный по каналу входной поток должен быть соединен с переданным по каналу потоком вывода; переданный по каналу входной поток тогда обеспечивает, любые байты данных пишутся переданному по каналу потоку вывода. Как правило, данные читаются из a PipedInputStream объект одним потоком и данными пишется соответствию PipedOutputStream некоторым другим потоком. Попытка использовать оба объекта от единственного потока не рекомендуется, поскольку она может мертвая блокировка поток. Переданный по каналу входной поток содержит буфер, разъединяя операции чтения от операций записи, в определенных рамках. Канал, как говорят, повреждается, если поток, который обеспечивал байты данных для соединенного переданного по каналу потока вывода, больше не жив.

С тех пор:

JDK1.0

См. Также:

PipedOutputStream

Полевая Сводка

Поля

Модификатор и Тип	Поле и Описание
protected byte[]	буфер Круговой буфер, в который помещаются входящие данные.
protected int	в Индекс позиции в круговом буфере, в котором следующий байт данных будет сохранен когда получено из соединенного переданного по каналу потока вывода.
protected int	Индекс позиции в круговом буфере, в котором следующий байт данных будет считан этим переданным по каналу входным потоком.
protected static int	PIPE_SIZE Размер по умолчанию кругового входного буфера канала.

Сводка конструктора

Конструкторы

Конструктор и Описание
PipedInputStream() Создает a PipedInputStream так, чтобы это еще не было соединено.
PipedInputStream(int pipeSize) Создает a PipedInputStream так, чтобы это еще не было соединено и использовало указанный размер канала для буфера канала.
PipedInputStream(PipedOutputStream src) Создает a PipedInputStream так, чтобы это было соединено с переданным по каналу потоком вывода src.
PipedInputStream(PipedOutputStream src, int pipeSize) Создает a PipedInputStream так, чтобы это было соединено с переданным по каналу потоком вывода src и использует указанный размер канала для буфера канала.

Сводка метода

Методы

Модификатор и Тип	Метод и Описание
int	available() Возвращает число байтов, которые могут быть считаны из этого входного потока без блокирования.
void	close() Завершения этот переданный по каналу входной поток и выпуски любые системные ресурсы связались с потоком.
void	connect(PipedOutputStream src) Причины этот переданный по каналу входной поток, который будет соединен с переданным по каналу потоком вывода src.
int	read() Читает следующий байт данных от этого переданного по каналу входного потока.
int	read(byte[] b, int off, int len) Чтения до len байты данных от этого переданного по каналу входного потока в массив байтов.
protected void	receive(int b) Получает байт данных.

Методы java.io унаследованный от класса. InputStream

mark, markSupported, read, reset, skip

Методы java.lang унаследованный от класса. Объект

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

Полевая Деталь

PIPE_SIZE

protected static final int PIPE_SIZE

Размер по умолчанию кругового входного буфера канала.

С тех пор:

JDK1.1

См. Также:

Постоянные Значения полей

буфер

protected byte[] buffer

Круговой буфер, в который помещаются входящие данные.

С тех пор:

JDK1.1

в

protected int in

Индекс позиции в круговом буфере, в котором следующий байт данных будет сохранен когда получено из соединенного переданного по каналу потока вывода. in<0 подразумевает, что буфер пуст, in==out подразумевает, что буфер полон

С тех пор:

JDK1.1

protected int out

Индекс позиции в круговом буфере, в котором следующий байт данных будет считан этим переданным по каналу входным потоком.

С тех пор:

JDK1.1

Деталь конструктора

PipedInputStream

public PipedInputStream(PipedOutputStream src)
                 throws IOException

Создает a PipedInputStream так, чтобы это было соединено с переданным по каналу потоком вывода src. Байты данных, записанные src тогда будет доступно как входной от этого потока.

Параметры:

src - поток, чтобы соединиться с.

Броски:

IOException - если ошибка ввода-вывода происходит.

PipedInputStream

public PipedInputStream(PipedOutputStream src,
                int pipeSize)
                 throws IOException

Создает a PipedInputStream так, чтобы это было соединено с переданным по каналу потоком вывода src и использует указанный размер канала для буфера канала. Байты данных, записанные src тогда будет доступно как входной от этого потока.

Параметры:

src - поток, чтобы соединиться с.

pipeSize - размер буфера канала.

Броски:

IOException - если ошибка ввода-вывода происходит.

IllegalArgumentException - если pipeSize <= 0.

Since:

1.6

PipedInputStream

public PipedInputStream()

Creates a PipedInputStream so that it is not yet connected. It must be connected to a PipedOutputStream before being used.

PipedInputStream

public PipedInputStream(int pipeSize)

Creates a PipedInputStream so that it is not yet connected and uses the specified pipe size for the pipe's buffer. It must be connected to a PipedOutputStream before being used.

Parameters:

pipeSize - the size of the pipe's buffer.

Throws:

IllegalArgumentException - if pipeSize <= 0.

Since:

1.6

Method Detail

connect

public void connect(PipedOutputStream src)
             throws IOException

Causes this piped input stream to be connected to the piped output stream src. If this object is already connected to some other piped output stream, an IOException is thrown.

If src is an unconnected piped output stream and snk is an unconnected piped input stream, they may be connected by either the call:

snk.connect(src) 

or the call:

src.connect(snk) 

The two calls have the same effect.

Parameters:

src - The piped output stream to connect to.

Throws:

IOException - if an I/O error occurs.

receive

protected void receive(int b)
                throws IOException

Receives a byte of data. This method will block if no input is available.

Parameters:

b - the byte being received

Throws:

IOException - If the pipe is broken, unconnected, closed, or if an I/O error occurs.

Since:

JDK1.1

read

public int read()
         throws IOException

Reads the next byte of data from this piped input stream. The value byte is returned as an int in the range 0 to 255. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Specified by:

read in class InputStream

Returns:

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

Throws:

IOException - if the pipe is unconnected, broken, closed, or if an I/O error occurs.

read

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

Reads up to len bytes of data from this piped input stream into an array of bytes. Less than len bytes will be read if the end of the data stream is reached or if len exceeds the pipe's buffer size. If len is zero, then no bytes are read and 0 is returned; otherwise, the method blocks until at least 1 byte of input is available, end of the stream has been detected, or an exception is thrown.

Overrides:

read in class InputStream

Parameters:

b - the buffer into which the data is read.

off - the start offset in the destination array b

len - the maximum number of bytes read.

Returns:

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.

Throws:

NullPointerException - If b is null.

IndexOutOfBoundsException - If off is negative, len is negative, or len is greater than b.length - off

IOException - if the pipe is broken, unconnected, closed, or if an I/O error occurs.

See Also:

InputStream.read()

available

public int available()
              throws IOException

Returns the number of bytes that can be read from this input stream without blocking.

Overrides:

available in class InputStream

Returns:

the number of bytes that can be read from this input stream without blocking, or 0 if this input stream has been closed by invoking its close() method, or if the pipe is unconnected, or broken.

Throws:

IOException - if an I/O error occurs.

Since:

JDK1.0.2

close

public void close()
           throws IOException

Closes this piped input stream and releases any system resources associated with the stream.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException - if an I/O error occurs.