Values
pumpshared pump pump
Interfaces
ReadStreamshared ReadStream<T>

Represents a stream of items that can be read from.

Any class that implements this interface can be used by a Pump to pump data from it to a WriteStream.

StreamBaseshared StreamBase

Base interface for a stream.

WriteStreamshared WriteStream<T>

Represents a stream of data that can be written to.

Any class that implements this interface can be used by a Pump to pump data from a ReadStream to it.

Classes
Pumpshared Pump

Pumps data from a ReadStream to a WriteStream and performs flow control where necessary to prevent the write stream buffer from getting overfull.

Instances of this class read items from a ReadStream and write them to a WriteStream. If data can be read faster than it can be written this could result in the write queue of the WriteStream growing without bound, eventually causing it to exhaust all available RAM.

To prevent this, after each write, instances of this class check whether the write queue of the WriteStream is full, and if so, the ReadStream is paused, and a drainHandler is set on the WriteStream.

When the WriteStream has processed half of its backlog, the drainHandler will be called, which results in the pump resuming the ReadStream.

This class can be used to pump from any ReadStream to any WriteStream, e.g. from an HttpServerRequest to an AsyncFile, or from NetSocket to a WebSocket.

Please see the documentation for more information.

pumpshared pump