okio

Class Pipe

java.lang.Object

okio.Pipe

public final class Pipe
extends java.lang.Object

A source and a sink that are attached. The sink's output is the source's input. Typically each is accessed by its own thread: a producer thread writes data to the sink and a consumer thread reads data from the source.

This class uses a buffer to decouple source and sink. This buffer has a user-specified maximum size. When a producer thread outruns its consumer the buffer fills up and eventually writes to the sink will block until the consumer has caught up. Symmetrically, if a consumer outruns its producer reads block until there is data to be read. Limits on the amount of time spent waiting for the other party can be configured with timeouts on the source and the sink.

When the sink is closed, source reads will continue to complete normally until the buffer has been exhausted. At that point reads will return -1, indicating the end of the stream. But if the source is closed first, writes to the sink will immediately fail with an IOException.

Constructor Summary

Constructors

Constructor and Description
Pipe(long maxBufferSize)

Method Summary

Modifier and Type	Method and Description
void	fold(Sink sink) Writes any buffered contents of this pipe to sink, then replace this pipe's source with sink.
Sink	sink()
Source	source()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Pipe

public Pipe(long maxBufferSize)

Method Detail

source

public final Source source()

sink

public final Sink sink()

fold

public void fold(Sink sink)
          throws java.io.IOException

Writes any buffered contents of this pipe to sink, then replace this pipe's source with sink. This pipe's source is closed and attempts to read it will throw an IllegalStateException. This method must not be called while concurrently accessing this pipe's source. It is safe, however, to call this while concurrently writing this pipe's sink.

Throws:

java.io.IOException