Broadway.Message (Broadway v1.0.0) View Source
This struct holds all information about a message.
A message is first created by the producers. It is then
sent downstream and gets updated multiple times, either
by a module implementing the Broadway
behaviour
through the Broadway.handle_message/3
callback
or internally by one of the built-in stages of Broadway.
Instead of modifying the struct directly, you should use the functions provided by this module to manipulate messages.
Link to this section Summary
Functions
Immediately acknowledges the given message or list of messages.
Configures the acknowledger of this message.
Mark a message as failed.
Defines the message batch key.
Sets the batching mode for the message.
Defines the target batcher which the message should be forwarded to.
Stores the given data in the message.
Updates the data in the message.
Link to this section Types
Specs
t() :: %Broadway.Message{ acknowledger: {module(), ack_ref :: term(), data :: term()}, batch_key: term(), batch_mode: :bulk | :flush, batcher: atom(), data: term(), metadata: %{optional(atom()) => term()}, status: :ok | {:failed, reason :: binary()} | {:throw | :error | :exit, term(), Exception.stacktrace()} }
Link to this section Functions
Specs
Immediately acknowledges the given message or list of messages.
This function can be used to acknowledge a message (or list of messages) immediately without waiting for the rest of the pipeline.
Acknowledging a message sets that message's acknowledger to a no-op acknowledger so that it's safe to ack at the end of the pipeline.
Returns the updated acked message if a message is passed in, or the updated list of acked messages if a list of messages is passed in.
Specs
Configures the acknowledger of this message.
This function calls the Broadway.Acknowledger.configure/3
callback to
change the configuration of the acknowledger for the given message
.
This function can only be called if the acknowledger implements the configure/3
callback. If it doesn't, an error is raised.
Specs
Mark a message as failed.
Failed messages are sent directly to the related acknowledger at the end of this step and therefore they're not forwarded to the next step in the pipeline.
Failing a message does not emit any log but it does trigger the
Broadway.handle_failed/2
callback.
Specs
Defines the message batch key.
The batch key identifies the batch the message belongs to, within
a given batcher. Each batcher then groups batches with the same
batch_key
, with size of at most batch_size
within period
batch_timeout
. Both batch_size
and batch_timeout
are managed
per batch key, so a batcher is capable of grouping multiple batch
keys at the same time, regardless of the concurrency level.
If a given batcher has multiple batch processors (concurrency > 1), all messages with the same batch key are routed to the same processor. So different batch keys may run concurrently but the same batch key is always run serially and in the same batcher processor.
Specs
Sets the batching mode for the message.
When the mode is :bulk
, the batch that the message is in is delivered after
the batch size or batch timeout is reached.
When the mode is :flush
, the batch that the message is in is delivered
immediately after processing. Note it doesn't mean the batch contains only a single element
but rather that all messages received from the processor are delivered without waiting.
The default mode for messages is :bulk
.
Specs
Defines the target batcher which the message should be forwarded to.
Specs
Stores the given data in the message.
This function is usually used inside the Broadway.handle_message/3
implementation
to replace data with new processed data.
Specs
Updates the data in the message.
This function is usually used inside the Broadway.handle_message/3
implementation
to update data with new processed data.