Deprecated
instead use ReadStream#pipe() or ReadStream#pipeTo(WriteStream)
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 io. to an io.,
or from io. to a io..
Please see the documentation for more information.
| Modifier and Type | Method and Description |
|---|---|
| public int | |
| public static <T> Pump | Returns: the pumpthe read stream rs, WriteStream<T> the write stream ws)
References Deprecated
Pump is deprecated or references (maybe indirectly) at least one deprecated element.
Create a new |
| public static <T> Pump | Returns: the pumpthe read stream rs, WriteStream<T> the write stream ws, int the max size of the write queue writeQueueMaxSize)
References Deprecated
Pump is deprecated or references (maybe indirectly) at least one deprecated element.
Create a new |
| public Pump | Returns: a reference to this, so the API can be used fluentlythe max size maxSize)
References Deprecated
Pump is deprecated or references (maybe indirectly) at least one deprecated element.
Set the write queue max size to |
| public Pump | |
| public Pump |
| numberPumped | back to summary |
|---|---|
| public int numberPumped() Return the total number of items pumped by this pump. | |
| pump | back to summary |
|---|---|
| public static <T> Pump pump(ReadStream<T> rs, WriteStream<T> ws)
References Deprecated
See corresponding docs for further information. Create a new
| |
| pump | back to summary |
|---|---|
| public static <T> Pump pump(ReadStream<T> rs, WriteStream<T> ws, int writeQueueMaxSize)
References Deprecated
See corresponding docs for further information. Create a new
| |
| setWriteQueueMaxSize | back to summary |
|---|---|
| public Pump setWriteQueueMaxSize(int maxSize)
References Deprecated
See corresponding docs for further information. Set the write queue max size to | |
| start | back to summary |
|---|---|
| public Pump start()
References Deprecated
See corresponding docs for further information. Start the Pump. The Pump can be started and stopped multiple times. | |
| stop | back to summary |
|---|---|
| public Pump stop()
References Deprecated
See corresponding docs for further information. Stop the Pump. The Pump can be started and stopped multiple times. | |