Amqpx.Basic.cancel

You're seeing just the function cancel, go back to Amqpx.Basic module for more information.
Link to this function

cancel(channel, consumer_tag, options \\ [])

Specs

cancel(Amqpx.Channel.t(), String.t(), keyword()) :: {:ok, String.t()} | error()

Stops the given consumer from consuming.

This method cancels a consumer. This does not affect already delivered messages, but it does mean the server will not send any more messages for that consumer. The client may receive an arbitrary number of messages in between sending the cancel method and receiving the reply.

consumer_tag identifies the "subscription" to cancel, that is, the subscription of a consumer to a specific queue. The consumer tag is returned by consume/4.

Options

  • :no_wait - If set, the cancel operation is asynchronous. Defaults to false.