public class Pump
extends java.lang.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 bytes 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.
Instances of this class are not thread-safe.
| Modifier and Type | Method and Description |
|---|---|
int |
bytesPumped()
Return the total number of bytes pumped by this pump.
|
static Pump |
createPump(ReadStream<?> rs,
WriteStream<?> ws)
Create a new
Pump with the given ReadStream and WriteStream |
static Pump |
createPump(ReadStream<?> rs,
WriteStream<?> 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.
|
public static Pump createPump(ReadStream<?> rs, WriteStream<?> ws)
Pump with the given ReadStream and WriteStreampublic static Pump createPump(ReadStream<?> rs, WriteStream<?> ws, int writeQueueMaxSize)
Pump with the given ReadStream and WriteStream and
writeQueueMaxSizepublic Pump setWriteQueueMaxSize(int maxSize)
maxSizepublic Pump start()
public Pump stop()
public int bytesPumped()