Skip to content

Most visited

Recently visited

navigation

PipedOutputStream

public class PipedOutputStream
extends OutputStream

java.lang.Object
   ↳ java.io.OutputStream
     ↳ java.io.PipedOutputStream


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.

See also:

Summary

Public constructors

PipedOutputStream(PipedInputStream snk)

Creates a piped output stream connected to the specified piped input stream.

PipedOutputStream()

Creates a piped output stream that is not yet connected to a piped input stream.

Public methods

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)

Writes len bytes from the specified byte array starting at offset off to this piped output stream.

void write(int b)

Writes the specified byte to the piped output stream.

Inherited methods

From class java.io.OutputStream
From class java.lang.Object
From interface java.io.Closeable
From interface java.io.Flushable
From interface java.lang.AutoCloseable

Public constructors

PipedOutputStream

Added in API level 1
PipedOutputStream (PipedInputStream snk)

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 PipedInputStream: The piped input stream to connect to.
Throws
IOException if an I/O error occurs.

PipedOutputStream

Added in API level 1
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.

See also:

Public methods

close

Added in API level 1
void close ()

Closes this piped output stream and releases any system resources associated with this stream. This stream may no longer be used for writing bytes.

Throws
IOException if an I/O error occurs.

connect

Added in API level 1
void connect (PipedInputStream snk)

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 PipedInputStream: the piped input stream to connect to.
Throws
IOException if an I/O error occurs.

flush

Added in API level 1
void flush ()

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.

Throws
IOException if an I/O error occurs.

write

Added in API level 1
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. This method blocks until all the bytes are written to the output stream.

Parameters
b byte: the data.
off int: the start offset in the data.
len int: the number of bytes to write.
Throws
IOException if the pipe is broken, unconnected, closed, or if an I/O error occurs.

write

Added in API level 1
void write (int b)

Writes the specified byte to the piped output stream.

Implements the write method of OutputStream.

Parameters
b int: the byte to be written.
Throws
IOException if the pipe is broken, unconnected, closed, or if an I/O error occurs.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.