| |
|
| java.lang.Object
 java.io.OutputStream
java.io.PipedOutputStream
| PipedOutputStream | | public class PipedOutputStream extends OutputStream (Code) | | 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.
author:
James Gosling
version:
1.34, 05/05/07
See Also: java.io.PipedInputStream
since:
JDK1.0 |
| Constructor Summary | |
| public | PipedOutputStream(PipedInputStream snk)
Creates a piped output stream connected to the specified piped
input stream. | | public | PipedOutputStream()
Creates a piped output stream that is not yet connected to a
piped input stream. |
| Method Summary | |
| public void | close()
Closes this piped output stream and releases any system resources
associated with this stream. | | public synchronized void | connect(PipedInputStream snk)
Connects this piped output stream to a receiver. | | public synchronized void | flush()
Flushes this output stream and forces any buffered output bytes
to be written out. | | public void | write(int b)
Writes the specified byte to the piped output stream. | | public void | write(byte b, int off, int len)
Writes len bytes from the specified byte array
starting at offset off to this piped output stream. |
| PipedOutputStream | | public PipedOutputStream(PipedInputStream snk) throws IOException(Code) | | 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.
exception:
IOException - if an I/O error occurs. |
| close | | public void close() throws IOException(Code) | | Closes this piped output stream and releases any system resources
associated with this stream. This stream may no longer be used for
writing bytes.
exception:
IOException - if an I/O error occurs. |
| connect | | public synchronized void connect(PipedInputStream snk) throws IOException(Code) | | 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.
exception:
IOException - if an I/O error occurs. |
| flush | | public synchronized void flush() throws IOException(Code) | | 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.
exception:
IOException - if an I/O error occurs. |
| write | | public void write(byte b, int off, int len) throws IOException(Code) | | 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.
Parameters:
off - the start offset in the data.
Parameters:
len - the number of bytes to write.
exception:
IOException - if the pipe is broken,PipedOutputStream.connect(java.io.PipedInputStream) unconnected,closed, or if an I/O error occurs. |
|
|
|