public class Pipe<T> 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 pipe 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<Pipe> |
__TYPE_ARG |
io.vertx.lang.rx.TypeArg<T> |
__typeArg_0 |
| Constructor and Description |
|---|
Pipe(Object delegate,
io.vertx.lang.rx.TypeArg<T> typeArg_0) |
Pipe(Pipe delegate) |
| Modifier and Type | Method and Description |
|---|---|
void |
close()
Close the pipe.
|
Pipe<T> |
endOnComplete(boolean end)
Set to
true to call WriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) when the source ReadStream completes, false otherwise. |
Pipe<T> |
endOnFailure(boolean end)
Set to
true to call WriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) when the source ReadStream fails, false otherwise. |
Pipe<T> |
endOnSuccess(boolean end)
Set to
true to call WriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) when the source ReadStream succeeds, false otherwise. |
boolean |
equals(Object o) |
Pipe |
getDelegate() |
int |
hashCode() |
static <T> Pipe<T> |
newInstance(Pipe arg) |
static <T> Pipe<T> |
newInstance(Pipe arg,
io.vertx.lang.rx.TypeArg<T> __typeArg_T) |
Single<Void> |
rxTo(WriteStream<T> dst)
Start to pipe the elements to the destination
WriteStream. |
void |
to(WriteStream<T> dst)
Start to pipe the elements to the destination
WriteStream. |
void |
to(WriteStream<T> dst,
Handler<AsyncResult<Void>> completionHandler)
Start to pipe the elements to the destination
WriteStream. |
String |
toString() |
public static final io.vertx.lang.rx.TypeArg<Pipe> __TYPE_ARG
public final io.vertx.lang.rx.TypeArg<T> __typeArg_0
public Pipe(Pipe delegate)
public Pipe getDelegate()
public Pipe<T> endOnFailure(boolean end)
true to call WriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) when the source ReadStream fails, false otherwise.end - true to end the stream on a source ReadStream failurepublic Pipe<T> endOnSuccess(boolean end)
true to call WriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) when the source ReadStream succeeds, false otherwise.end - true to end the stream on a source ReadStream successpublic Pipe<T> endOnComplete(boolean end)
true to call WriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) when the source ReadStream completes, false otherwise.
Calling this overwrites endOnFailure(boolean) and endOnSuccess(boolean).
end - true to end the stream on a source ReadStream completionpublic void to(WriteStream<T> dst, Handler<AsyncResult<Void>> completionHandler)
WriteStream.
When the operation fails with a write error, the source stream is resumed.
dst - the destination write streamcompletionHandler - the handler called when the pipe operation completespublic void to(WriteStream<T> dst)
WriteStream.
When the operation fails with a write error, the source stream is resumed.
dst - the destination write streampublic Single<Void> rxTo(WriteStream<T> dst)
WriteStream.
When the operation fails with a write error, the source stream is resumed.
dst - the destination write streampublic void close()
The streams handlers will be unset and the read stream resumed unless it is already ended.
Copyright © 2023 Eclipse. All rights reserved.