Added in API level 1

PipedOutputStream

open class PipedOutputStream : OutputStream

kotlin.Any
↳	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.

Summary

Public constructors
`PipedOutputStream(snk: PipedInputStream!)` 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
open Unit	`close()` Closes this piped output stream and releases any system resources associated with this stream.
open Unit	`connect(snk: PipedInputStream!)` Connects this piped output stream to a receiver.
open Unit	`flush()` Flushes this output stream and forces any buffered output bytes to be written out.
open Unit	`write(b: Int)` Writes the specified `byte` to the piped output stream.
open Unit	`write(b: ByteArray!, off: Int, len: Int)` Writes `len` bytes from the specified byte array starting at offset `off` to this piped output stream.

Inherited functions

From class OutputStream

OutputStream!

nullOutputStream()

Returns a new OutputStream which discards all bytes. The returned stream is initially open. The stream is closed by calling the close() method. Subsequent calls to close() have no effect.

While the stream is open, the write(int), write(byte[]), and write(byte[], int, int) methods do nothing. After the stream has been closed, these methods all throw IOException.

The flush() method does nothing.

Unit

write(b: ByteArray!)

Writes b.length bytes from the specified byte array to this output stream. The general contract for write(b) is that it should have exactly the same effect as the call write(b, 0, b.length).

Public constructors

PipedOutputStream

Added in API level 1

PipedOutputStream(snk: PipedInputStream!)

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.

Exceptions
`java.io.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

open fun close(): Unit

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

Exceptions
`java.lang.Exception`	if this resource cannot be closed
`java.io.IOException`	if an I/O error occurs.
`java.io.IOException`	if an I/O error occurs.

connect

Added in API level 1

open fun connect(snk: PipedInputStream!): Unit

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.

Exceptions
`java.io.IOException`	if an I/O error occurs.

flush

Added in API level 1

open fun flush(): Unit

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.

Exceptions
`java.io.IOException`	if an I/O error occurs.
`java.io.IOException`	if an I/O error occurs.

write

Added in API level 1

open fun write(b: Int): Unit

Writes the specified byte to the piped output stream.

Implements the write method of OutputStream.

Parameters
`b`	Int: the `byte` to be written.

Exceptions
`java.io.IOException`	if an I/O error occurs. In particular, an `IOException` may be thrown if the output stream has been closed.
`java.io.IOException`	if the pipe is broken, `unconnected`, closed, or if an I/O error occurs.

write

Added in API level 1

open fun write(
    b: ByteArray!, 
    off: Int, 
    len: Int
): Unit

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`	ByteArray!: the data.
`off`	Int: the start offset in the data.
`len`	Int: the number of bytes to write.

Exceptions
`java.io.IOException`	if an I/O error occurs. In particular, an `IOException` is thrown if the output stream is closed.
`java.io.IOException`	if the pipe is broken, `unconnected`, closed, or if an I/O error occurs.