public class Pump extends Object
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.
NOTE: This class has been automatically generated from theoriginal
non RX-ified interface using Vert.x codegen.Modifier and Type | Field and Description |
---|---|
static io.vertx.lang.rx.TypeArg<Pump> |
__TYPE_ARG |
Constructor and Description |
---|
Pump(Object delegate) |
Pump(Pump delegate) |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o) |
Pump |
getDelegate() |
int |
hashCode() |
static Pump |
newInstance(Pump arg) |
int |
numberPumped()
Return the total number of items pumped by this pump.
|
static <T> Pump |
pump(Flowable<T> rs,
WriteStream<T> ws)
Create a new
Pump with the given ReadStream and WriteStream |
static <T> Pump |
pump(Flowable<T> rs,
WriteStream<T> ws,
int writeQueueMaxSize)
Create a new
Pump with the given ReadStream and WriteStream and
writeQueueMaxSize |
Pump |
setWriteQueueMaxSize(int maxSize)
Set the write queue max size to
maxSize |
Pump |
start()
Start the Pump.
|
Pump |
stop()
Stop the Pump.
|
String |
toString() |
public static final io.vertx.lang.rx.TypeArg<Pump> __TYPE_ARG
public Pump getDelegate()
public static <T> Pump pump(Flowable<T> rs, WriteStream<T> ws)
Pump
with the given ReadStream
and WriteStream
rs
- the read streamws
- the write streampublic static <T> Pump pump(Flowable<T> rs, WriteStream<T> ws, int writeQueueMaxSize)
Pump
with the given ReadStream
and WriteStream
and
writeQueueMaxSize
rs
- the read streamws
- the write streamwriteQueueMaxSize
- the max size of the write queuepublic Pump setWriteQueueMaxSize(int maxSize)
maxSize
maxSize
- the max sizepublic Pump start()
public Pump stop()
public int numberPumped()
Copyright © 2022 Eclipse. All rights reserved.