Interface Consumer

All Superinterfaces:
AutoCloseable, Resource
public interface Consumer extends AutoCloseable, Resource
API to consume messages from a RabbitMQ queue.

Instances are configured and created with a ConsumerBuilder.

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Consumer.BatchContext
    Context to accumulate message contexts and settle them at once.
    static interface 
    Consumer.Context
    Context for message processing.
    static interface 
    Consumer.MessageHandler
    Contract to process a message.

    Nested classes/interfaces inherited from interface Resource

    Resource.State, Resource.StateListener

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    Close the consumer with its resources.
    void
    pause()
    Pause the consumer to stop receiving messages.
    void
    unpause()
    Request to receive messages again.
    long
    unsettledMessageCount()
    Return the number of unsettled messages.

  • Method Details

    • pause

      void pause()
      Pause the consumer to stop receiving messages.

      Messages already in flight when this method is called may still be delivered after it returns.

      Throws:
      AmqpException - if the consumer is not open

    • unsettledMessageCount

      long unsettledMessageCount()
      Return the number of unsettled messages.
      Returns:
      unsettled message count

    • unpause

      void unpause()
      Request to receive messages again.
      Throws:
      AmqpException - if the consumer is not open

    • close

      void close()
      Close the consumer with its resources.
      Specified by:
      close in interface AutoCloseable