vertx / io.vertx.rxjava.core.streams / Pump

Pump

open class Pump

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

Instances of this class read items from a io.vertx.rxjava.core.streams.ReadStream and write them to a io.vertx.rxjava.core.streams.WriteStream. If data can be read faster than it can be written this could result in the write queue of the io.vertx.rxjava.core.streams.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 io.vertx.rxjava.core.streams.WriteStream is full, and if so, the io.vertx.rxjava.core.streams.ReadStream is paused, and a drainHandler is set on the io.vertx.rxjava.core.streams.WriteStream.

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

This class can be used to pump from any io.vertx.rxjava.core.streams.ReadStream to any io.vertx.rxjava.core.streams.WriteStream, e.g. from an io.vertx.rxjava.core.http.HttpServerRequest to an io.vertx.rxjava.core.file.AsyncFile, or from io.vertx.rxjava.core.net.NetSocket to a io.vertx.rxjava.core.http.WebSocket.

Please see the documentation for more information.

NOTE: This class has been automatically generated from the io.vertx.core.streams.Pump non RX-ified interface using Vert.x codegen.

Constructors

<init>

Pump(delegate: Pump)

Properties

__TYPE_ARG

static val __TYPE_ARG: TypeArg<Pump>

Functions

equals

open fun equals(other: Any?): Boolean

getDelegate

open fun getDelegate(): Pump

hashCode

open fun hashCode(): Int

newInstance

open static fun newInstance(arg: Pump): Pump

numberPumped

open fun numberPumped(): Int

Return the total number of items pumped by this pump.

pump

open static fun <T : Any> pump(rs: ReadStream<T>, ws: WriteStream<T>): Pump
open static fun <T : Any> pump(rs: Observable<T>, ws: WriteStream<T>): Pump

Create a new Pump with the given ReadStream and WriteStream

open static fun <T : Any> pump(rs: ReadStream<T>, ws: WriteStream<T>, writeQueueMaxSize: Int): Pump
open static fun <T : Any> pump(rs: Observable<T>, ws: WriteStream<T>, writeQueueMaxSize: Int): Pump

Create a new Pump with the given ReadStream and WriteStream and writeQueueMaxSize

setWriteQueueMaxSize

open fun setWriteQueueMaxSize(maxSize: Int): Pump

Set the write queue max size to maxSize

start

open fun start(): Pump

Start the Pump. The Pump can be started and stopped multiple times.

stop

open fun stop(): Pump

Stop the Pump. The Pump can be started and stopped multiple times.

toString

open fun toString(): String