Class: java.io.PipedInputStream

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.
Authors:
@author James Gosling
See:
@see java.io.PipedOutputStream
Since:
@since JDK1.0

Inheritance

Superclass tree: Implements:

Methods

  • PipedInputStreamtop

    public PipedInputStream()
    Creates a PipedInputStream so that it is not yet connected. It must be connected to a PipedOutputStream before being used.
    Related Links:
    Google Code Search
    Stack Overflow

  • PipedInputStreamtop

    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:
    @param pipeSize the size of the pipe's buffer.
    Exceptions:
    @exception IllegalArgumentException if pipeSize <_ _0="_0" code="code">.
    Since:
    @since 1.6
    Related Links:
    Google Code Search
    Stack Overflow

  • PipedInputStreamtop

    public PipedInputStream(PipedOutputStream src) throws IOException
    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:
    @param src the stream to connect to.
    Exceptions:
    @exception IOException if an I/O error occurs.
    Related Links:
    Google Code Search
    Stack Overflow

  • PipedInputStreamtop

    public PipedInputStream(PipedOutputStream src, int pipeSize) throws IOException
    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:
    @param src the stream to connect to.
    @param pipeSize the size of the pipe's buffer.
    Exceptions:
    @exception IOException if an I/O error occurs.
    @exception IllegalArgumentException if pipeSize <_ _0="_0" code="code">.
    Since:
    @since 1.6
    Related Links:
    Google Code Search
    Stack Overflow

  • availabletop

    public synchronized int available() throws IOException
    Returns the number of bytes that can be read from this input stream without blocking.
    Return:
    @return 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 java.io.PipedInputStream.close() method, or if the pipe is unconnected , or broken.
    Exceptions:
    @exception IOException if an I/O error occurs.
    Since:
    @since JDK1.0.2
    Override hierarchy:
    available from InputStream
    Related Links:
    Google Code Search
    Stack Overflow

  • closetop

    public void close() throws IOException
    Closes this piped input stream and releases any system resources associated with the stream.
    Exceptions:
    @exception IOException if an I/O error occurs.
    Specified by:
    close from Closeable
    Override hierarchy:
    close from InputStream
    Related Links:
    Google Code Search
    Stack Overflow

  • connecttop

    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:
    @param src The piped output stream to connect to.
    Exceptions:
    @exception IOException if an I/O error occurs.
    Related Links:
    Google Code Search
    Stack Overflow

  • readtop

    public synchronized 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.
    Return:
    @return the next byte of data, or -1 if the end of the stream is reached.
    Exceptions:
    @exception IOException if the pipe is unconnected , broken, closed, or if an I/O error occurs.
    Override hierarchy:
    read from InputStream
    Related Links:
    Google Code Search
    Stack Overflow

  • readtop

    public synchronized 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.
    Parameters:
    @param b the buffer into which the data is read.
    @param off the start offset in the destination array b
    @param len the maximum number of bytes read.
    Return:
    @return 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.
    Exceptions:
    @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, unconnected , closed, or if an I/O error occurs.
    Override hierarchy:
    read from InputStream
    Related Links:
    Google Code Search
    Stack Overflow

  • receivetop

    synchronized protected void receive(int b) throws IOException
    Receives a byte of data. This method will block if no input is available.
    Parameters:
    @param b the byte being received
    Exceptions:
    @exception IOException If the pipe is broken, unconnected , closed, or if an I/O error occurs.
    Since:
    @since JDK1.1
    Related Links:
    Google Code Search
    Stack Overflow

Fields

  • PIPE_SIZE

    static final protected int PIPE_SIZE = 1024
    The default size of the pipe's circular input buffer.

  • buffer

    protected byte[] buffer
    The circular buffer into which incoming data is placed.

  • in

    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. in<0 implies the buffer is empty, in==out implies the buffer is full

  • out

    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.