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 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 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 the original non RX-ified interface using Vert.x codegen.

  • Field Details

    • __TYPE_ARG

      public static final io.vertx.lang.rx.TypeArg<Pipe> __TYPE_ARG

    • __typeArg_0

      public final io.vertx.lang.rx.TypeArg<T> __typeArg_0

  • Constructor Details

    • Pipe

      public Pipe(Pipe delegate)

    • Pipe

      public Pipe(Object delegate, io.vertx.lang.rx.TypeArg<T> typeArg_0)

  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getDelegate

      public Pipe getDelegate()
      Specified by:
      getDelegate in interface io.vertx.lang.rx.RxDelegate

    • endOnFailure

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

    • endOnSuccess

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

    • endOnComplete

      public Pipe<T> endOnComplete(boolean end)
      Set to true to call WriteStream.end() when the source ReadStream completes, false otherwise.

      Calling this overwrites endOnFailure(boolean) and endOnSuccess(boolean).

      Parameters:
      end - true to end the stream on a source ReadStream completion
      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 destination WriteStream.

      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 destination WriteStream.

      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.

    • newInstance

      public static <T> Pipe<T> newInstance(Pipe arg)

    • newInstance

      public static <T> Pipe<T> newInstance(Pipe arg, io.vertx.lang.rx.TypeArg<T> __typeArg_T)