- 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 aPipedOutputStreamobject by one thread and data is read from the connectedPipedInputStreamby 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:
- 1.0
- See Also:
PipedInputStream
-
-
Constructor Summary
Constructors Constructor 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()Closes this piped output stream and releases any system resources associated with this stream.voidconnect(PipedInputStream snk)Connects this piped output stream to a receiver.voidflush()Flushes this output stream and forces any buffered output bytes to be written out.voidwrite(byte[] b, int off, int len)Writeslenbytes from the specified byte array starting at offsetoffto this piped output stream.voidwrite(int b)Writes the specifiedbyteto the piped output stream.-
Methods declared in class java.io.OutputStream
nullOutputStream, 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, anIOExceptionis thrown.If
snkis an unconnected piped input stream andsrcis 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 IOExceptionWrites the specifiedbyteto the piped output stream.Implements the
writemethod ofOutputStream.- Specified by:
writein classOutputStream- Parameters:
b- thebyteto 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 IOExceptionWriteslenbytes from the specified byte array starting at offsetoffto this piped output stream. This method blocks until all the bytes are written to the output stream.- Overrides:
writein 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 IOExceptionFlushes 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:
flushin interfaceFlushable- Overrides:
flushin classOutputStream- Throws:
IOException- if an I/O error occurs.
-
close
public void close() throws IOExceptionCloses 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:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Overrides:
closein classOutputStream- Throws:
IOException- if an I/O error occurs.
-
-