Package io.vertx.mutiny.amqp

Class AmqpReceiver

java.lang.Object
io.vertx.mutiny.amqp.AmqpReceiver
All Implemented Interfaces:
MutinyDelegate, ReadStream<AmqpMessage>, StreamBase
public class AmqpReceiver extends Object implements ReadStream<AmqpMessage>, MutinyDelegate
Interface used to consume AMQP message as a stream of message. Back pressure is implemented using AMQP credits.

NOTE: This class has been automatically generated from the original non Mutiny-ified interface.

See Also:
  • AmqpReceiver

  • Field Details

  • Constructor Details

    • AmqpReceiver

      public AmqpReceiver(io.vertx.amqp.AmqpReceiver delegate)
      Create a new instance of AmqpReceiver delegating to the given (non-null) instance of AmqpReceiver.

    • AmqpReceiver

      public AmqpReceiver(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.amqp.AmqpReceiver getDelegate()
      Get the delegate instance.

      This method returns the instance on which this shim is delegating the calls. And so, give you access to the bare API.

      Specified by:
      getDelegate in interface MutinyDelegate
      Specified by:
      getDelegate in interface ReadStream<AmqpMessage>
      Specified by:
      getDelegate in interface StreamBase
      Returns:
      the delegate instance

    • close

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> close()
      Closes the receiver.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • AmqpReceiver.close()

    • closeAndAwait

      public void closeAndAwait()
      Closes the receiver.

      Unlike the bare Vert.x variant, this method returns a Void. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      See Also:
      • AmqpReceiver.close()

    • closeAndForget

      public AmqpReceiver closeAndForget()
      Closes the receiver.

      Unlike the bare Vert.x variant, this method ignores the Void result or any failure.

      Returns:
      The current instance to chain operations if needed.
      See Also:
      • AmqpReceiver.close()

    • pipeTo

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> pipeTo(WriteStream<AmqpMessage> dst)
      Pipe this ReadStream to the WriteStream.

      Elements emitted by this stream will be written to the write stream until this stream ends or fails.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Specified by:
      pipeTo in interface ReadStream<AmqpMessage>
      Parameters:
      dst - the destination write stream
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • io.vertx.amqp.AmqpReceiver#pipeTo(WriteStream)

    • pipeToAndAwait

      public void pipeToAndAwait(WriteStream<AmqpMessage> dst)
      Pipe this ReadStream to the WriteStream.

      Elements emitted by this stream will be written to the write stream until this stream ends or fails.

      Unlike the bare Vert.x variant, this method returns a Void. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Parameters:
      dst - the destination write stream
      See Also:
      • io.vertx.amqp.AmqpReceiver#pipeTo(WriteStream)

    • pipeToAndForget

      public AmqpReceiver pipeToAndForget(WriteStream<AmqpMessage> dst)
      Pipe this ReadStream to the WriteStream.

      Elements emitted by this stream will be written to the write stream until this stream ends or fails.

      Unlike the bare Vert.x variant, this method ignores the Void result or any failure.

      Parameters:
      dst - the destination write stream
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • io.vertx.amqp.AmqpReceiver#pipeTo(WriteStream)

    • exceptionHandler

      public AmqpReceiver exceptionHandler(Consumer<Throwable> handler)
      Description copied from interface: ReadStream
      Set an exception handler on the read stream.
      Specified by:
      exceptionHandler in interface ReadStream<AmqpMessage>
      Specified by:
      exceptionHandler in interface StreamBase
      Parameters:
      handler - the exception handler. Can be null.
      Returns:
      a reference to this, so the API can be used fluently

    • handler

      public AmqpReceiver handler(Consumer<AmqpMessage> handler)
      Description copied from interface: ReadStream
      Set a data handler. As data is read, the handler will be called with the data.
      Specified by:
      handler in interface ReadStream<AmqpMessage>
      Returns:
      a reference to this, so the API can be used fluently

    • pause

      public AmqpReceiver pause()
      Description copied from interface: ReadStream
      Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.

      While it's paused, no data will be sent to the data handler.

      Specified by:
      pause in interface ReadStream<AmqpMessage>
      Returns:
      a reference to this, so the API can be used fluently

    • resume

      public AmqpReceiver resume()
      Description copied from interface: ReadStream
      Resume reading, and sets the buffer in flowing mode.

      If the ReadStream has been paused, reading will recommence on it.

      Specified by:
      resume in interface ReadStream<AmqpMessage>
      Returns:
      a reference to this, so the API can be used fluently

    • fetch

      public AmqpReceiver fetch(long amount)
      Description copied from interface: ReadStream
      Fetch the specified amount of elements. If the ReadStream has been paused, reading will recommence with the specified amount of items, otherwise the specified amount will be added to the current stream demand.
      Specified by:
      fetch in interface ReadStream<AmqpMessage>
      Returns:
      a reference to this, so the API can be used fluently

    • endHandler

      public AmqpReceiver endHandler(Runnable endHandler)
      Description copied from interface: ReadStream
      Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.
      Specified by:
      endHandler in interface ReadStream<AmqpMessage>
      Returns:
      a reference to this, so the API can be used fluently

    • address

      public String address()
      The listened address.
      Returns:
      the address, not null

    • connection

      public AmqpConnection connection()
      Gets the connection having created the receiver. Cannot be null
      Returns:
      the connection having created the receiver.

    • unwrap

      public io.vertx.proton.ProtonReceiver unwrap()
      Returns:
      the underlying ProtonReceiver.

    • pipe

      public Pipe<AmqpMessage> pipe()
      Pause this stream and return a Pipe to transfer the elements of this stream to a destination WriteStream.

      The stream will be resumed when the pipe will be wired to a WriteStream.

      Specified by:
      pipe in interface ReadStream<AmqpMessage>
      Returns:
      a pipe

    • newInstance

      public static AmqpReceiver newInstance(io.vertx.amqp.AmqpReceiver delegate)
      Creates a new instance of the AmqpReceiver.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toMulti

      @CheckReturnValue public io.smallrye.mutiny.Multi<AmqpMessage> toMulti()

    • toBlockingIterable

      public Iterable<AmqpMessage> toBlockingIterable()

    • toBlockingStream

      public Stream<AmqpMessage> toBlockingStream()