Commanded v0.14.0-rc.0 Commanded.Middleware.Pipeline View Source
Pipeline is a struct used as an argument in the callback functions of modules implementing the Commanded.Middleware
behaviour.
This struct must be returned by each function to be used in the next middleware based on the configured middleware chain.
Pipeline fields
assigns
- shared user data as a map.command
- the command struct being dispatched.consistency
- the requested dispatch consistency, either::eventual
(default) or:strong
identity
- an atom specifying a field in the command containing the aggregate’s identity or a one-arity function that returns an identity from the command being dispatched.halted
- the boolean status on whether the pipeline was haltedresponse
- set the response to send back to the caller
Link to this section Summary
Functions
Puts the key
with value equal to value
into assigns
map
Executes the middleware chain
Halts the pipeline by preventing further middleware downstream from being invoked
Has the pipeline been halted?
Sets the response to be returned to the dispatch caller
Extract the response from the pipeline, if present, or use the given response
Link to this section Functions
Puts the key
with value equal to value
into assigns
map
Executes the middleware chain
Halts the pipeline by preventing further middleware downstream from being invoked.
Prevents dispatch of the command if halt
occurs in a before_dispatch
callback.
Has the pipeline been halted?
Sets the response to be returned to the dispatch caller
Extract the response from the pipeline, if present, or use the given response