Franklin
v0.1.0

View Source Franklin.CommandedApplication (Franklin v0.1.0)

Link to this section Summary

Functions

aggregate_state(aggregate_module, aggregate_uuid, timeout \\ 5000)

Retrieve aggregate state of an aggregate.

child_spec(opts)
config()

Callback implementation for Commanded.Application.config/0.

start_link(opts \\ [])

Callback implementation for Commanded.Application.start_link/1.

stop(pid, timeout \\ 5000)

Callback implementation for Commanded.Application.stop/2.

Link to this section Functions

Link to this function

aggregate_state(aggregate_module, aggregate_uuid, timeout \\ 5000)

View Source 
@spec aggregate_state(
  aggregate_module :: module(),
  aggregate_uuid :: Commanded.Aggregates.Aggregate.uuid(),
  timeout :: integer()
) :: Commanded.Aggregates.Aggregate.state()

Retrieve aggregate state of an aggregate.

Retrieving aggregate state is done by calling to the opened aggregate, or querying the event store for an optional state snapshot and then replaying the aggregate's event stream.

Link to this function

child_spec(opts)

View Source 
@spec child_spec(opts :: Commanded.Application.options()) :: Supervisor.child_spec()
Link to this function

config()

View Source

Callback implementation for Commanded.Application.config/0.

Link to this function

start_link(opts \\ [])

View Source

Callback implementation for Commanded.Application.start_link/1.

Link to this function

stop(pid, timeout \\ 5000)

View Source

Callback implementation for Commanded.Application.stop/2.