Rabbit v0.6.0 Rabbit.Message View Source
A message consumed by a Rabbit.Consumer
.
After starting a consumer, any message passed to the Rabbit.Consumer.handle_message/1
callback will be wrapped in a messsage struct. The struct has the following
fields:
:consumer
- The PID of the consumer process.:module
- The module of the consumer process.:channel
- TheAMQP.Channel
being used by the consumer.:payload
- The raw payload of the message.:decoded_payload
- If the message has a content type - this will be the payload decoded using the applicable serializer.:meta
- The metadata sent when publishing or set by the broker.:error_reason
- The reason for any error that occurs during the message handling callback.:error_stack
- The stacktrace that might accompany the error.
Link to this section Summary
Functions
Awknowledges a message.
Negative awknowledges a message.
Creates a new message struct.
Rejects a message.
Link to this section Types
Link to this section Functions
Link to this function
ack(message, opts \\ [])
View Source
ack(message, opts \\ [])
View Source
ack(Rabbit.Message.t(), keyword()) :: :ok | {:error, :blocked | :closing}
ack(Rabbit.Message.t(), keyword()) :: :ok | {:error, :blocked | :closing}
Awknowledges a message.
Options
:multiple
- Iftrue
, all messages up to the one specified by itsdelivery_tag
are considered acknowledged by the server.
Link to this function
nack(message, opts \\ [])
View Source
nack(message, opts \\ [])
View Source
nack(Rabbit.Message.t(), keyword()) :: :ok | {:error, :blocked | :closing}
nack(Rabbit.Message.t(), keyword()) :: :ok | {:error, :blocked | :closing}
Negative awknowledges a message.
Options
:multiple
- Iftrue
, all messages up to the one specified by itdelivery_tag
are considered acknowledged by the server.:requeue
- Iftrue
, the message will be returned to the queue and redelivered to the next available consumer.
Link to this function
new(consumer, module, channel, payload, meta)
View Source
new(consumer, module, channel, payload, meta)
View Source
new(Rabbit.Consumer.t(), module(), AMQP.Channel.t(), any(), map()) ::
Rabbit.Message.t()
new(Rabbit.Consumer.t(), module(), AMQP.Channel.t(), any(), map()) :: Rabbit.Message.t()
Creates a new message struct.
Link to this function
reject(message, opts \\ [])
View Source
reject(message, opts \\ [])
View Source
reject(Rabbit.Message.t(), keyword()) :: :ok | {:error, :blocked | :closing}
reject(Rabbit.Message.t(), keyword()) :: :ok | {:error, :blocked | :closing}
Rejects a message.
Options
:requeue
- Iftrue
, the message will be returned to the queue and redelivered to the next available consumer.