PipedOutputStream JDK 1.6)

Description

public class PipedOutputStream

A piped output stream can be connected to a piped input stream to create a communications pipe.

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.

See also: PipedInputStream

Constructors

public PipedOutputStream ()

Creates a piped output stream that is not yet connected to a piped input stream.

public PipedOutputStream (PipedInputStream snk) throws IOException

Creates a piped output stream connected to the specified piped input stream.

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.

Methods

Hide/Show inherited methods

public void close () throws IOException [Overrides OutputStream]

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

publicsynchronized void connect (PipedInputStream snk) throws IOException

Connects this piped output stream to a receiver.

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.
Parameters:
- snk - the piped input stream to connect to.
Throws:
- IOException - if an I/O error occurs.

publicsynchronized void flush () throws IOException [Overrides OutputStream]

Flushes this output stream and forces any buffered output bytes to be written out.

public void write (byte[] b) throws IOException [Inherited From OutputStream]

Writes b.length bytes from the specified byte array to this output stream.

Writes b.length bytes from the specified byte array
to this output stream. The general contract for write(b)
is that it should have exactly the same effect as the call
write(b, 0, b.length).
Parameters:
- b - the data.
Throws:
- IOException - if an I/O error occurs.
See Also: OutputStream.write(byte[], int, int),

public void write (byte[] b, int off, int len) throws IOException [Overrides OutputStream]

Writes len bytes from the specified byte array starting at offset off to this piped output stream.

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.
Parameters:
- b - the data.
- off - the start offset in the data.
- len - the number of bytes to write.
Throws:
- IOException - if the pipe is broken, {@link #connect(java.io.PipedInputStream) unconnected}, closed, or if an I/O error occurs.

public void write (int b) throws IOException [Specified in OutputStream]

Writes the specified byte to the piped output stream.

Implements the write method of OutputStream.
Parameters:
- b - the byte to be written.
Throws:
- IOException - if the pipe is broken, {@link #connect(java.io.PipedInputStream) unconnected}, closed, or if an I/O error occurs.