Class RabbitMQConsumer

java.lang.Object
io.vertx.rxjava3.rabbitmq.RabbitMQConsumer
All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate, ReadStream<RabbitMQMessage>, StreamBase
public class RabbitMQConsumer extends Object implements io.vertx.lang.rx.RxDelegate, ReadStream<RabbitMQMessage>
A stream of messages from a rabbitmq queue.

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<RabbitMQConsumer> __TYPE_ARG

  • Constructor Details

    • RabbitMQConsumer

      public RabbitMQConsumer(RabbitMQConsumer delegate)

    • RabbitMQConsumer

      public RabbitMQConsumer(Object delegate)

  • 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 RabbitMQConsumer getDelegate()
      Specified by:
      getDelegate in interface ReadStream<RabbitMQMessage>
      Specified by:
      getDelegate in interface io.vertx.lang.rx.RxDelegate
      Specified by:
      getDelegate in interface StreamBase

    • toObservable

      public Observable<RabbitMQMessage> toObservable()
      Specified by:
      toObservable in interface ReadStream<RabbitMQMessage>

    • toFlowable

      public Flowable<RabbitMQMessage> toFlowable()
      Specified by:
      toFlowable in interface ReadStream<RabbitMQMessage>

    • pipe

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

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

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

    • pipeTo

      public Completable pipeTo(WriteStream<RabbitMQMessage> 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.

      Specified by:
      pipeTo in interface ReadStream<RabbitMQMessage>
      Parameters:
      dst - the destination write stream
      Returns:
      a future notified when the write stream will be ended with the outcome

    • rxPipeTo

      public Completable rxPipeTo(WriteStream<RabbitMQMessage> 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.

      Specified by:
      rxPipeTo in interface ReadStream<RabbitMQMessage>
      Parameters:
      dst - the destination write stream
      Returns:
      a future notified when the write stream will be ended with the outcome

    • exceptionHandler

      public RabbitMQConsumer exceptionHandler(Handler<Throwable> exceptionHandler)
      Set an exception handler on the read stream.
      Specified by:
      exceptionHandler in interface ReadStream<RabbitMQMessage>
      Specified by:
      exceptionHandler in interface StreamBase
      Parameters:
      exceptionHandler - the exception handler
      Returns:
      a reference to this, so the API can be used fluently

    • handler

      public RabbitMQConsumer handler(Handler<RabbitMQMessage> messageArrived)
      Set a message handler. As message appear in a queue, the handler will be called with the message.
      Specified by:
      handler in interface ReadStream<RabbitMQMessage>
      Parameters:
      messageArrived -
      Returns:
      a reference to this, so the API can be used fluently

    • pause

      public RabbitMQConsumer pause()
      Pause the stream of incoming messages from queue.

      The messages will continue to arrive, but they will be stored in a internal queue. If the queue size would exceed the limit provided by , then incoming messages will be discarded.

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

    • resume

      public RabbitMQConsumer resume()
      Resume reading from a queue. Flushes internal queue.
      Specified by:
      resume in interface ReadStream<RabbitMQMessage>
      Returns:
      a reference to this, so the API can be used fluently

    • endHandler

      public RabbitMQConsumer endHandler(Handler<Void> endHandler)
      Set an end handler. Once the stream has canceled successfully, the handler will be called.
      Specified by:
      endHandler in interface ReadStream<RabbitMQMessage>
      Parameters:
      endHandler -
      Returns:
      a reference to this, so the API can be used fluently

    • queueName

      public String queueName()
      Returns:
      the name of the queue

    • setQueueName

      public RabbitMQConsumer setQueueName(String name)
      Set the name of the queue. This method is typically only required during a connectionEstablishedCallback when the queue name has changed.
      Parameters:
      name - the name of the queue
      Returns:
      a reference to this, so the API can be used fluently

    • consumerTag

      public String consumerTag()
      Returns:
      a consumer tag

    • cancel

      public Completable cancel()
      Stop message consumption from a queue.

      The operation is asynchronous. When consumption is stopped, you can also be notified via endHandler(Handler)

      Returns:
      a future through which you can find out the operation status.

    • rxCancel

      public Completable rxCancel()
      Stop message consumption from a queue.

      The operation is asynchronous. When consumption is stopped, you can also be notified via endHandler(Handler)

      Returns:
      a future through which you can find out the operation status.

    • isCancelled

      public boolean isCancelled()
      Return true if cancel() has been called.
      Returns:
      true if cancel() has been called.

    • isPaused

      public boolean isPaused()
      Returns:
      is the stream paused?

    • fetch

      public RabbitMQConsumer fetch(long amount)
      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<RabbitMQMessage>
      Parameters:
      amount -
      Returns:
      a reference to this, so the API can be used fluently

    • newInstance

      public static RabbitMQConsumer newInstance(RabbitMQConsumer arg)