Home » openjdk-7 » java » io » [javadoc | source]
java.io
public class: PipedInputStream [javadoc | source]
java.lang.Object
   java.io.InputStream
      java.io.PipedInputStream

All Implemented Interfaces:
    Closeable

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.
Field Summary
 boolean closedByWriter     
volatile  boolean closedByReader     
 boolean connected     
 Thread readSide     
 Thread writeSide     
protected static final  int PIPE_SIZE    The default size of the pipe's circular input buffer.
    since: JDK1.1 -
 
protected  byte[] buffer    The circular buffer into which incoming data is placed.
    since: JDK1.1 -
 
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
    since: JDK1.1 -
 
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.
    since: JDK1.1 -
 
Constructor:
 public PipedInputStream() 
 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:
    src - the stream to connect to.
    Throws:
    IOException - if an I/O error occurs.
    exception: IOException - if an I/O error occurs.
 public PipedInputStream(int pipeSize) 
 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:
    src - the stream to connect to.
    pipeSize - the size of the pipe's buffer.
    Throws:
    IOException - if an I/O error occurs.
    IllegalArgumentException - if pipeSize <= 0.
    exception: IOException - if an I/O error occurs.
    exception: IllegalArgumentException - if pipeSize <= 0.
    since: 1.6 -
Method from java.io.PipedInputStream Summary:
available,   close,   connect,   read,   read,   receive,   receive,   receivedLast
Methods from java.io.InputStream:
available,   close,   mark,   markSupported,   read,   read,   read,   reset,   skip
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.io.PipedInputStream Detail:
 public synchronized int available() throws IOException 
    Returns the number of bytes that can be read from this input stream without blocking.
 public  void close() throws IOException 
    Closes this piped input stream and releases any system resources associated with the stream.
 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.

 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.
 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.
 protected synchronized  void receive(int b) throws IOException 
    Receives a byte of data. This method will block if no input is available.
 synchronized  void receive(byte[] b,
    int off,
    int len) throws IOException 
    Receives data into an array of bytes. This method will block until some input is available.
 synchronized  void receivedLast() 
    Notifies all waiting threads that the last byte of data has been received.