Listener - rabbitmq : Listener

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

Methods

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

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

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

Retrieve the rabbitmq:Channel, which initializes this rabbitmq:Listener.

LifeCycle Methods

Attaches the service to the rabbitmq:Listener endpoint.

Starts consuming the messages on all the attached services.

Methods

__detach

(service s)

returns error?
Isolated Function

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

Parameters

  • s service
  • Type descriptor of the service

  • Return Type

    (error?)
  • () or else a rabbitmq:Error upon failure to detach the service

__gracefulStop

()

returns error?
Isolated Function

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

  • Return Type

    (error?)
  • () or else a rabbitmq:Error upon failure to close the ChannelListener

__immediateStop

()

returns error?
Isolated Function

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

  • Return Type

    (error?)
  • () or else a rabbitmq:Error upon failure to close ChannelListener.

getChannel

()

returns Channel
Isolated Function

Retrieve the rabbitmq:Channel, which initializes this rabbitmq:Listener.

  • Return Type

    (Channel)
  • A rabbitmq:Channel object or else a rabbitmq:Error if an I/O problem is encountered.

LifeCycle Methods

__attach

(service s, string? name)

returns error?
Isolated Function

Attaches the service to the rabbitmq:Listener endpoint.

Parameters

  • s service
  • Type descriptor of the service

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

  • Return Type

    (error?)
  • () or else a rabbitmq:Error upon failure to register the service

__start

()

returns error?
Isolated Function

Starts consuming the messages on all the attached services.

  • Return Type

    (error?)
  • () or else a rabbitmq:Error upon failure to start