Listener - rabbitmq : Listener

Ballerina RabbitMQ Message Listener. Provides a listener to consume messages from the RabbitMQ server.

Constructor

__init

(ConnectionConfiguration | Connection connectionOrConnectionConfig, int? prefetchCount, int? prefetchSize)

  • prefetchCount int? ()
  • Maximum number of messages that the server will deliver, 0 if unlimited. Unless explicitly given, this value is 10 by default.

  • prefetchSize int? ()
  • Maximum amount of content (measured in octets) that the server will deliver, 0 if unlimited.

Methods

LifeCycle Methods

Methods

__detach

(service s)

returns error?

Stops consuming messages and detaches the service from the Listener endpoint.

Parameters

  • s service
  • Type descriptor of the service to bind to.

  • Return Type

    (error?)
  • Nil or error upon failure to detach service.

__gracefulStop

()

returns error?

Stops consuming messages through all consumer services by terminating the connection and all its channels.

  • Return Type

    (error?)
  • Nil or error upon failure to close the ChannelListener

__immediateStop

()

returns error?

Stops consuming messages through all consumer services and terminate the connection with the server.

  • Return Type

    (error?)
  • Nil or error upon failure to close ChannelListener.

getChannel

()

returns Channel

Retrieve the Channel which initializes this Listener.

  • Return Type

    (Channel)
  • RabbitMQ Channel object or error if an I/O problem is encountered.

LifeCycle Methods

__attach

(service s, string? name)

returns error?

Attaches the service to the Listener endpoint.

Parameters

  • s service
  • Type descriptor of the service to bind to.

  • name string? (default ())
  • Name of the service.

  • Return Type

    (error?)
  • Nil or error upon failure to register service.

__start

()

returns error?

Starts the consuming messages on all attached services.

  • Return Type

    (error?)
  • Nil or error upon failure to start.