Class Pipe<T>
- java.lang.Object
-
- io.vertx.reactivex.core.streams.Pipe<T>
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate
public class Pipe<T> extends Object implements io.vertx.lang.rx.RxDelegate
Pipe data from aReadStreamto aWriteStreamand performs flow control where necessary to prevent the write stream buffer from getting overfull.Instances of this class read items from a
ReadStreamand write them to aWriteStream. If data can be read faster than it can be written this could result in the write queue of theWriteStreamgrowing 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
WriteStreamis full, and if so, theReadStreamis paused, and adrainHandleris set on theWriteStream.When the
WriteStreamhas processed half of its backlog, thedrainHandlerwill be called, which results in the pump resuming theReadStream.This class can be used to pipe from any
ReadStreamto anyWriteStream, e.g. from anHttpServerRequestto anAsyncFile, or fromNetSocketto aWebSocket.Please see the documentation for more information.
NOTE: This class has been automatically generated from the
originalnon RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<Pipe>__TYPE_ARGio.vertx.lang.rx.TypeArg<T>__typeArg_0
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()Close the pipe.Pipe<T>endOnComplete(boolean end)Pipe<T>endOnFailure(boolean end)Pipe<T>endOnSuccess(boolean end)booleanequals(Object o)PipegetDelegate()inthashCode()static <T> Pipe<T>newInstance(Pipe arg)static <T> Pipe<T>newInstance(Pipe arg, io.vertx.lang.rx.TypeArg<T> __typeArg_T)CompletablerxTo(WriteStream<T> dst)Start to pipe the elements to the destinationWriteStream.Future<Void>to(WriteStream<T> dst)Start to pipe the elements to the destinationWriteStream.StringtoString()
-
-
-
Method Detail
-
getDelegate
public Pipe getDelegate()
- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate
-
endOnFailure
public Pipe<T> endOnFailure(boolean end)
- Parameters:
end-trueto end the stream on a sourceReadStreamfailure- Returns:
- a reference to this, so the API can be used fluently
-
endOnSuccess
public Pipe<T> endOnSuccess(boolean end)
- Parameters:
end-trueto end the stream on a sourceReadStreamsuccess- Returns:
- a reference to this, so the API can be used fluently
-
endOnComplete
public Pipe<T> endOnComplete(boolean end)
Set totrueto callWriteStream.end()when the sourceReadStreamcompletes,falseotherwise.Calling this overwrites
endOnFailure(boolean)andendOnSuccess(boolean).- Parameters:
end-trueto end the stream on a sourceReadStreamcompletion- Returns:
- a reference to this, so the API can be used fluently
-
to
public Future<Void> to(WriteStream<T> dst)
Start to pipe the elements to the destinationWriteStream.When the operation fails with a write error, the source stream is resumed.
- Parameters:
dst- the destination write stream- Returns:
- a future notified when the pipe operation completes
-
rxTo
public Completable rxTo(WriteStream<T> dst)
Start to pipe the elements to the destinationWriteStream.When the operation fails with a write error, the source stream is resumed.
- Parameters:
dst- the destination write stream- Returns:
- a future notified when the pipe operation completes
-
close
public void close()
Close the pipe.The streams handlers will be unset and the read stream resumed unless it is already ended.
-
-