public class PipedOutputStream extends OutputStream
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.
PipedInputStreampublic 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.
snk - The piped input stream to connect to.IOException - if an I/O error occurs.public PipedOutputStream()
Creates a piped output stream that is not yet connected to a piped input stream. It must be connected to a piped input stream, either by the receiver or the sender, before being used.
public 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.
snk - the piped input stream to connect to.IOException - if an I/O error occurs.public void write(int b)
throws IOException Writes the specified byte to the piped output stream.
Implements the write method of OutputStream.
write in class OutputStream
b - the byte to be written.IOException - if the pipe is broken, unconnected, closed, or if an I/O error occurs.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.
write in class OutputStream
b - the data.off - the start offset in the data.len - the number of bytes to write.IOException - if the pipe is broken, unconnected, closed, or if an I/O error occurs.public 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.
flush in interface Flushable
flush in class OutputStream
IOException - if an I/O error occurs.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.
close in interface Closeable
close in interface AutoCloseable
close in class OutputStream
IOException - if an I/O error occurs.
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.