- java.lang.Object
-
- java.io.OutputStream
-
- java.io.PipedOutputStream
-
- All Implemented Interfaces:
- Closeable, Flushable, AutoCloseable
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 aPipedOutputStream
object by one thread and data is read from the connectedPipedInputStream
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.- Since:
- JDK1.0
- See Also:
PipedInputStream
-
-
Constructor Summary
Constructors Constructor and Description PipedOutputStream()
Creates a piped output stream that is not yet connected to a piped input stream.PipedOutputStream(PipedInputStream snk)
Creates a piped output stream connected to the specified piped input stream.
-
Method Summary
Methods Modifier and Type Method and Description void
close()
Closes this piped output stream and releases any system resources associated with this stream.void
connect(PipedInputStream snk)
Connects this piped output stream to a receiver.void
flush()
Flushes this output stream and forces any buffered output bytes to be written out.void
write(byte[] b, int off, int len)
Writeslen
bytes from the specified byte array starting at offsetoff
to this piped output stream.void
write(int b)
Writes the specifiedbyte
to the piped output stream.-
Methods inherited from class java.io.OutputStream
write
-
-
-
-
Constructor Detail
-
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 fromsnk
.- Parameters:
snk
- The piped input stream to connect to.- Throws:
IOException
- if an I/O error occurs.
-
PipedOutputStream
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.
-
-
Method Detail
-
connect
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, anIOException
is thrown.If
snk
is an unconnected piped input stream andsrc
is an unconnected piped output stream, they may be connected by either the call:
or the call:src.connect(snk)
The two calls have the same effect.snk.connect(src)
- Parameters:
snk
- the piped input stream to connect to.- Throws:
IOException
- if an I/O error occurs.
-
write
public void write(int b) throws IOException
Writes the specifiedbyte
to the piped output stream.Implements the
write
method ofOutputStream
.- Specified by:
write
in classOutputStream
- Parameters:
b
- thebyte
to be written.- Throws:
IOException
- if the pipe is broken,unconnected
, closed, or if an I/O error occurs.
-
write
public void write(byte[] b, int off, int len) throws IOException
Writeslen
bytes from the specified byte array starting at offsetoff
to this piped output stream. This method blocks until all the bytes are written to the output stream.- Overrides:
write
in classOutputStream
- 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,unconnected
, closed, or if an I/O error occurs.
-
flush
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.- Specified by:
flush
in interfaceFlushable
- Overrides:
flush
in classOutputStream
- Throws:
IOException
- if an I/O error occurs.
-
close
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.- Specified by:
close
in interfaceCloseable
- Specified by:
close
in interfaceAutoCloseable
- Overrides:
close
in classOutputStream
- Throws:
IOException
- if an I/O error occurs.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/io/pipedoutputstream.html/.html/
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.