| |
|
| java.lang.Object
 java.io.InputStream
java.io.PipedInputStream
| PipedInputStream | | public class PipedInputStream extends InputStream (Code) | | A piped input stream should be connected
to a piped output stream; the piped input
stream then provides whatever data bytes
are written to the piped output stream.
Typically, data is read from a PipedInputStream
object by one thread and data is written
to the corresponding PipedOutputStream
by some other thread. Attempting to use
both objects from a single thread is not
recommended, as it may deadlock the thread.
The piped input stream contains a buffer,
decoupling read operations from write operations,
within limits.
A pipe is said to be broken if a
thread that was providing data bytes to the connected
piped output stream is no longer alive.
author:
James Gosling
version:
1.40, 12/01/05
See Also: java.io.PipedOutputStream
since:
JDK1.0 |
| Field Summary | |
| final protected static int | PIPE_SIZE
The default size of the pipe's circular input buffer. | | protected byte | buffer
The circular buffer into which incoming data is placed. | | volatile boolean | closedByReader
| | boolean | closedByWriter
| | boolean | connected
| | protected int | in
The index of the position in the circular buffer at which the
next byte of data will be stored when received from the connected
piped output stream. | | protected int | out
The index of the position in the circular buffer at which the next
byte of data will be read by this piped input stream. | | Thread | readSide
| | Thread | writeSide
|
| Constructor Summary | |
| public | PipedInputStream(PipedOutputStream src)
Creates a PipedInputStream so
that it is connected to the piped output
stream src. | | public | PipedInputStream(PipedOutputStream src, int pipeSize)
Creates a PipedInputStream so that it is
connected to the piped output stream
src and uses the specified pipe size for
the pipe's buffer. | | public | PipedInputStream()
Creates a PipedInputStream so
that it is not yet
. | | public | PipedInputStream(int pipeSize)
Creates a PipedInputStream so that it is not yet
and
uses the specified pipe size for the pipe's buffer. |
| Method Summary | |
| public synchronized int | available()
Returns the number of bytes that can be read from this input
stream without blocking. | | public void | close()
Closes this piped input stream and releases any system resources
associated with the stream. | | public void | connect(PipedOutputStream src)
Causes this piped input stream to be connected
to the piped output stream src. | | public synchronized int | read()
Reads the next byte of data from this piped input stream. | | public synchronized int | read(byte b, int off, int len)
Reads up to len bytes of data from this piped input
stream into an array of bytes. | | protected synchronized void | receive(int b)
Receives a byte of data. | | synchronized void | receive(byte b, int off, int len)
Receives data into an array of bytes. | | synchronized void | receivedLast()
Notifies all waiting threads that the last byte of data has been
received. |
| PIPE_SIZE | | final protected static int PIPE_SIZE(Code) | | The default size of the pipe's circular input buffer.
since:
JDK1.1 |
| buffer | | protected byte buffer(Code) | | The circular buffer into which incoming data is placed.
since:
JDK1.1 |
| closedByReader | | volatile boolean closedByReader(Code) | | |
| closedByWriter | | boolean closedByWriter(Code) | | |
| connected | | boolean connected(Code) | | |
| in | | protected int in(Code) | | The index of the position in the circular buffer at which the
next byte of data will be stored when received from the connected
piped output stream. in<0 implies the buffer is empty,
in==out implies the buffer is full
since:
JDK1.1 |
| out | | protected int out(Code) | | The index of the position in the circular buffer at which the next
byte of data will be read by this piped input stream.
since:
JDK1.1 |
| PipedInputStream | | public PipedInputStream(PipedOutputStream src) throws IOException(Code) | | Creates a PipedInputStream so
that it is connected to the piped output
stream src. Data bytes written
to src will then be available
as input from this stream.
Parameters:
src - the stream to connect to.
exception:
IOException - if an I/O error occurs. |
| PipedInputStream | | public PipedInputStream(PipedOutputStream src, int pipeSize) throws IOException(Code) | | Creates a PipedInputStream so that it is
connected to the piped output stream
src and uses the specified pipe size for
the pipe's buffer.
Data bytes written to src will then
be available as input from this stream.
Parameters:
src - the stream to connect to.
Parameters:
pipeSize - the size of the pipe's buffer.
exception:
IOException - if an I/O error occurs.
exception:
IllegalArgumentException - if pipeSize <= 0.
since:
1.6 |
| PipedInputStream | | public PipedInputStream()(Code) | | Creates a PipedInputStream so
that it is not yet
.
It must be
to a
PipedOutputStream before being used.
|
| PipedInputStream | | public PipedInputStream(int pipeSize)(Code) | | Creates a PipedInputStream so that it is not yet
and
uses the specified pipe size for the pipe's buffer.
It must be
to a PipedOutputStream before being used.
Parameters:
pipeSize - the size of the pipe's buffer.
exception:
IllegalArgumentException - if pipeSize <= 0.
since:
1.6 |
| close | | public void close() throws IOException(Code) | | Closes this piped input stream and releases any system resources
associated with the stream.
exception:
IOException - if an I/O error occurs. |
| connect | | public void connect(PipedOutputStream src) throws IOException(Code) | | 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.
exception:
IOException - if an I/O error occurs. |
| read | | public synchronized int read() throws IOException(Code) | | 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.
the next byte of data, or -1 if the end of thestream is reached.
exception:
IOException - if the pipe isPipedInputStream.connect(java.io.PipedOutputStream) unconnected, broken, closed,or if an I/O error occurs. |
| read | | public synchronized int read(byte b, int off, int len) throws IOException(Code) | | 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.
Parameters:
b - the buffer into which the data is read.
Parameters:
off - the start offset in the destination array b
Parameters:
len - the maximum number of bytes read. the total number of bytes read into the buffer, or-1 if there is no more data because the end ofthe stream has been reached.
exception:
NullPointerException - If b is null.
exception:
IndexOutOfBoundsException - If off is negative, len is negative, or len is greater than b.length - off
exception:
IOException - if the pipe is broken,PipedInputStream.connect(java.io.PipedOutputStream) unconnected,closed, or if an I/O error occurs. |
| receive | | synchronized void receive(byte b, int off, int len) throws IOException(Code) | | Receives data into an array of bytes. This method will
block until some input is available.
Parameters:
b - the buffer into which the data is received
Parameters:
off - the start offset of the data
Parameters:
len - the maximum number of bytes received
exception:
IOException - If the pipe is broken,PipedInputStream.connect(java.io.PipedOutputStream) unconnected,closed,or if an I/O error occurs. |
| receivedLast | | synchronized void receivedLast()(Code) | | Notifies all waiting threads that the last byte of data has been
received.
|
|
|
|