Packages
commanded
0.17.4
1.4.10
1.4.9
1.4.8
1.4.7
1.4.6
1.4.3
1.4.2
1.4.1
1.4.0
1.4.0-rc.0
1.3.1
1.3.0
1.2.0
1.1.1
1.1.0
1.0.1
1.0.0
1.0.0-rc.1
1.0.0-rc.0
0.19.1
0.19.0
0.18.1
0.18.0
0.17.5
0.17.4
0.17.3
0.17.2
0.17.1
0.17.0
0.16.0
0.16.0-rc.1
0.16.0-rc.0
0.15.1
0.15.0
0.14.0
0.14.0-rc.0
0.13.0
0.12.0
0.11.0
0.10.0
0.9.0
0.8.5
0.8.4
0.8.3
0.8.1
0.8.0
0.7.1
0.6.2
0.6.1
0.6.0
0.4.0
0.3.1
0.3.0
0.2.1
0.2.0
0.1.0
Use Commanded to build your own Elixir applications following the CQRS/ES pattern.
Current section
Files
Jump to
Current section
Files
lib/commanded/aggregates/execution_context.ex
defmodule Commanded.Aggregates.ExecutionContext do
@moduledoc """
Defines the arguments used to execute a command for an aggregate.
The available options are:
- `command` - the command to execute, typically a struct
(e.g. `%OpenBankAccount{...}`).
- `retry_attempts` - the number of retries permitted if an
`{:error, :wrong_expected_version}` is encountered when appending events.
- `causation_id` - the UUID assigned to the dispatched command.
- `correlation_id` - a UUID used to correlate related commands/events.
- `metadata` - a map of key/value pairs containing the metadata to be
associated with all events created by the command.
- `handler` - the module that handles the command. It may be either the
aggregate module itself or a separate command handler module.
- `function` - the name of function, as an atom, that handles the command.
The default value is `:execute`, used to support command dispatch directly
to the aggregate module. For command handlers the `:handle` function is
used.
- `lifespan` - a module implementing the `Commanded.Aggregates.AggregateLifespan`
behaviour to control the aggregate instance process lifespan. The default
value, `Commanded.Aggregates.DefaultLifespan`, keeps the process running
indefinitely.
"""
alias Commanded.Aggregates.DefaultLifespan
defstruct [
:command,
:retry_attempts,
:causation_id,
:correlation_id,
:function,
:handler,
lifespan: DefaultLifespan,
metadata: %{},
]
end