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

All Implemented Interfaces:
    Flushable, Closeable

A piped output stream can be connected to a piped input stream to create a communications pipe. The piped output stream is the sending end of the pipe. Typically, data is written to a PipedOutputStream object by one thread and data is read from the connected PipedInputStream by some other thread. Attempting to use both objects from a single thread is not recommended as it may deadlock the thread. The pipe is said to be broken if a thread that was reading data bytes from the connected piped input stream is no longer alive.
Constructor:
 public PipedOutputStream() 
 public PipedOutputStream(PipedInputStream snk) throws IOException 
    Creates a piped output stream connected to the specified piped input stream. Data bytes written to this stream will then be available as input from snk.
    Parameters:
    snk - The piped input stream to connect to.
    Throws:
    IOException - if an I/O error occurs.
    exception: IOException - if an I/O error occurs.
Method from java.io.PipedOutputStream Summary:
close,   connect,   flush,   write,   write
Methods from java.io.OutputStream:
close,   flush,   write,   write,   write
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.io.PipedOutputStream Detail:
 public  void close() throws IOException 
    Closes this piped output stream and releases any system resources associated with this stream. This stream may no longer be used for writing bytes.
 public synchronized  void connect(PipedInputStream snk) throws IOException 
    Connects this piped output stream to a receiver. If this object is already connected to some other piped input stream, an IOException is thrown.

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

    src.connect(snk)
    or the call:
    snk.connect(src)
    The two calls have the same effect.
 public synchronized  void flush() throws IOException 
    Flushes this output stream and forces any buffered output bytes to be written out. This will notify any readers that bytes are waiting in the pipe.
 public  void write(int b) throws IOException 
    Writes the specified byte to the piped output stream.

    Implements the write method of OutputStream.

 public  void write(byte[] b,
    int off,
    int len) throws IOException 
    Writes len bytes from the specified byte array starting at offset off to this piped output stream. This method blocks until all the bytes are written to the output stream.