Vert.x 4.5.13 · io.vertx.core.streams.Pipe · APIdia, the JavaDoc alternative

Pipe data from a 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 io.vertx.core.http.HttpServerRequest to an io.vertx.core.file.AsyncFile, or from io.vertx.core.net.NetSocket to a io.vertx.core.http.WebSocket.

Please see the documentation for more information.

Method Summary

Modifier and Type	Method and Description
public void	close() Close the pipe.
public Pipe<T>	Returns: a reference to this, so the API can be used fluently endOnComplete(boolean `true` to end the stream on a source `ReadStream` completion end) Set to `true` to call `WriteStream#end()` when the source `ReadStream` completes, `false` otherwise.
public Pipe<T>	Returns: a reference to this, so the API can be used fluently endOnFailure(boolean `true` to end the stream on a source `ReadStream` failure end) Set to `true` to call `WriteStream#end()` when the source `ReadStream` fails, `false` otherwise.
public Pipe<T>	Returns: a reference to this, so the API can be used fluently endOnSuccess(boolean `true` to end the stream on a source `ReadStream` success end) Set to `true` to call `WriteStream#end()` when the source `ReadStream` succeeds, `false` otherwise.
public default Future<Void>	to(WriteStream<T> dst) Same as `to(WriteStream, Handler)` but returns a `Future` of the asynchronous result
public void	to(WriteStream<T> the destination write stream dst, Handler<AsyncResult<Void>> the handler called when the pipe operation completes completionHandler) Start to pipe the elements to the destination `WriteStream`.

Method Detail

close	back to summary
public void close() Close the pipe. The streams handlers will be unset and the read stream resumed unless it is already ended.

back to summary

public void close()

Close the pipe.

The streams handlers will be unset and the read stream resumed unless it is already ended.

endOnComplete back to summary

endOnComplete	back to summary
public Pipe<T> endOnComplete(boolean end) Set to `true` to call `WriteStream#end()` when the source `ReadStream` completes, `false` otherwise. Calling this overwrites `endOnFailure` and `endOnSuccess`. Parameters end:boolean `true` to end the stream on a source `ReadStream` completion Returns:Pipe<T> a reference to this, so the API can be used fluently Annotations @Fluent

public Pipe<T> endOnComplete(boolean end)

Set to true to call WriteStream#end() when the source ReadStream completes, false otherwise.

Calling this overwrites endOnFailure and endOnSuccess.

Parameters

end:boolean: true to end the stream on a source ReadStream completion

Returns:Pipe<T>

a reference to this, so the API can be used fluently

Annotations

@Fluent

endOnFailure back to summary

endOnFailure	back to summary
public Pipe<T> endOnFailure(boolean end) Set to `true` to call `WriteStream#end()` when the source `ReadStream` fails, `false` otherwise. Parameters end:boolean `true` to end the stream on a source `ReadStream` failure Returns:Pipe<T> a reference to this, so the API can be used fluently Annotations @Fluent

public Pipe<T> endOnFailure(boolean end)

Set to true to call WriteStream#end() when the source ReadStream fails, false otherwise.

Parameters

end:boolean: true to end the stream on a source ReadStream failure

Returns:Pipe<T>

a reference to this, so the API can be used fluently

Annotations

@Fluent

endOnSuccess back to summary

endOnSuccess	back to summary
public Pipe<T> endOnSuccess(boolean end) Set to `true` to call `WriteStream#end()` when the source `ReadStream` succeeds, `false` otherwise. Parameters end:boolean `true` to end the stream on a source `ReadStream` success Returns:Pipe<T> a reference to this, so the API can be used fluently Annotations @Fluent

public Pipe<T> endOnSuccess(boolean end)

Set to true to call WriteStream#end() when the source ReadStream succeeds, false otherwise.

Parameters

end:boolean: true to end the stream on a source ReadStream success

Returns:Pipe<T>

a reference to this, so the API can be used fluently

Annotations

@Fluent

to	back to summary
public default Future<Void> to(WriteStream<T> dst) Same as `to(WriteStream, Handler)` but returns a `Future` of the asynchronous result

to back to summary

to	back to summary
public void to(WriteStream<T> dst, Handler<AsyncResult<Void>> completionHandler) Start to pipe the elements to the destination `WriteStream`. When the operation fails with a write error, the source stream is resumed. Parameters dst:WriteStream<T> the destination write stream completionHandler:Handler<AsyncResult<Void>> the handler called when the pipe operation completes

public void to(WriteStream<T> dst, Handler<AsyncResult<Void>> completionHandler)

Start to pipe the elements to the destination WriteStream.

When the operation fails with a write error, the source stream is resumed.

Parameters

dst:WriteStream<T>: the destination write stream
completionHandler:Handler<AsyncResult<Void>>: the handler called when the pipe operation completes

public Interface Pipe<T>

Method Summary

Method Detail