Module java.base
Package java.io

Class PipedOutputStream

  • All Implemented Interfaces:
    Closeable,Flushable,AutoCloseable
    public classPipedOutputStreamextendsOutputStream
    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 bebroken 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 Detail

      • PipedOutputStream

        public PipedOutputStream​(PipedInputStream snk)                  throwsIOException
        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.

    • Method Detail

      • connect

        public void connect​(PipedInputStream snk)             throwsIOException
        Connects this piped output stream to a receiver. If this object is already connected to some other piped input stream, anIOException is thrown.

        Ifsnk is an unconnected piped input stream andsrc 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.

      • write

        public void write​(int b)           throwsIOException
        Writes the specifiedbyte to the piped output stream.

        Implements thewrite method ofOutputStream.

        Specified by:
        write in class OutputStream
        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)           throwsIOException
        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 class OutputStream
        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()           throwsIOException
        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 interface Flushable
        Overrides:
        flush in class OutputStream
        Throws:
        IOException - if an I/O error occurs.

      • close

        public void close()           throwsIOException
        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 interface AutoCloseable
        Specified by:
        close in interface Closeable
        Overrides:
        close in class OutputStream
        Throws:
        IOException - if an I/O error occurs.