Documentation
¶
Overview ¶
Package engine contains an in-memory Dogma engine.
Index ¶
- Constants
- func Run(ctx context.Context, e *Engine, d time.Duration, opts ...OperationOption) error
- func RunTimeScaled(ctx context.Context, e *Engine, d time.Duration, f float64, t time.Time, ...) error
- type CommandExecutor
- type Engine
- type EventRecorder
- type OperationOption
- func EnableAggregates(enabled bool) OperationOption
- func EnableIntegrations(enabled bool) OperationOption
- func EnableProcesses(enabled bool) OperationOption
- func EnableProjections(enabled bool) OperationOption
- func WithCurrentTime(t time.Time) OperationOption
- func WithObserver(o fact.Observer) OperationOption
- type Option
Constants ¶
const DefaultTickInterval = 250 * time.Millisecond
DefaultTickInterval is the default interval at which Run() and RunTimeScaled() will perform an engine tick.
Variables ¶
This section is empty.
Functions ¶
func Run ¶ added in v0.5.0
Run repeatedly calls e.Tick() until ctx is canceled or an error occurs.
d is the duration between ticks. If it is 0, DefaultTickInterval is used.
func RunTimeScaled ¶ added in v0.5.0
func RunTimeScaled( ctx context.Context, e *Engine, d time.Duration, f float64, t time.Time, opts ...OperationOption, ) error
RunTimeScaled repeatedly calls e.Tick() until ctx is canceled or an error occurs.
d is the duration between ticks. If it is 0, DefaultTickInterval is used.
Each tick is performed using a WithCurrentTime() option that scales time by a factor of f. For example, if f is 2.0, the engine will see time progress by 2 seconds for every 1 second of real time.
t is the "epoch time", used as current time for the first tick. If t.IsZero() is true, the current time is used.
Types ¶
type CommandExecutor ¶ added in v0.7.0
type CommandExecutor struct {
// Engine is the engine that handles the recorded events.
Engine *Engine
// Options is a set of options used when dispatching the message to the
// engine.
Options []OperationOption
}
CommandExecutor adapts an Engine to the dogma.CommandExecutor interface.
func (CommandExecutor) ExecuteCommand ¶ added in v0.7.0
ExecuteCommand enqueues a command for execution.
It panics if the command is not routed to any handlers.
type Engine ¶
type Engine struct {
// contains filtered or unexported fields
}
Engine is an in-memory Dogma engine that is used to execute tests.
func MustNew ¶ added in v0.8.1
func MustNew(app dogma.Application, options ...Option) *Engine
MustNew returns a new engine that uses the given app configuration, or panics if unable to do so.
func New ¶
func New(app dogma.Application, options ...Option) (_ *Engine, err error)
New returns a new engine that uses the given app configuration.
func (*Engine) Dispatch ¶
func (e *Engine) Dispatch( ctx context.Context, m dogma.Message, options ...OperationOption, ) error
Dispatch processes a message.
It is not an error to process a message that is not routed to any handlers.
It panics if the message is invalid.
type EventRecorder ¶ added in v0.7.0
type EventRecorder struct {
// Engine is the engine that handles the recorded events.
Engine *Engine
// Options is a set of options used when dispatching the message to the
// engine.
Options []OperationOption
}
EventRecorder adapts an Engine to the dogma.EventRecorder interface.
func (EventRecorder) RecordEvent ¶ added in v0.7.0
RecordEvent records the occurrence of an event.
It is not an error to record an event that is not routed to any handlers.
type OperationOption ¶
type OperationOption func(*operationOptions)
OperationOption applies optional settings while dispatching a message or performing a tick.
func EnableAggregates ¶
func EnableAggregates(enabled bool) OperationOption
EnableAggregates returns an operation option that enables or disables aggregate message handlers.
All handler types are enabled by default.
func EnableIntegrations ¶
func EnableIntegrations(enabled bool) OperationOption
EnableIntegrations returns an operation option that enables or disables integration message handlers.
All handler types are enabled by default.
func EnableProcesses ¶
func EnableProcesses(enabled bool) OperationOption
EnableProcesses returns an operation option that enables or disables process message handlers.
All handler types are enabled by default.
func EnableProjections ¶
func EnableProjections(enabled bool) OperationOption
EnableProjections returns an operation option that enables or disables projection message handlers.
All handler types are enabled by default.
func WithCurrentTime ¶
func WithCurrentTime(t time.Time) OperationOption
WithCurrentTime returns an operation option that sets the engine's current time.
Note that if this option is used with the test runner, it will take precedence over both the testkit.WithStartTime() option and any adjustments to the test clock made via Test.AdvanceTime().
func WithObserver ¶
func WithObserver(o fact.Observer) OperationOption
WithObserver returns an option that registers the given observer for the duration of the operation.
Multiple observers can be registered during a single operation.
type Option ¶
type Option func(*engineOptions)
Option applies optional engine-wide settings.
func EnableProjectionCompactionDuringHandling ¶ added in v0.10.0
EnableProjectionCompactionDuringHandling returns an engine option that causes projection to be compacted in parallel with each event handled.
This option is intended to faciliate testing of compaction logic alongside projection building. It is likely not much use when using the engine outside of the test runner.
func WithResetter ¶
func WithResetter(fn func()) Option
WithResetter returns an engine option that registers a reset hook with the engine.
fn is a function to be called whenever the engine is reset.
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package controller contains interfaces that the engine uses to consume controllers for each of the message handler types.
|
Package controller contains interfaces that the engine uses to consume controllers for each of the message handler types. |
|
aggregate
Package aggregate provides engine components that handle messages that are routed to aggregate message handlers.
|
Package aggregate provides engine components that handle messages that are routed to aggregate message handlers. |
|
integration
Package integration provides engine components that handle messages that are routed to integration message handlers.
|
Package integration provides engine components that handle messages that are routed to integration message handlers. |
|
process
Package process provides engine components that handle messages that are routed to process message handlers.
|
Package process provides engine components that handle messages that are routed to process message handlers. |
|
projection
Package projection provides engine components that handle messages that are routed to projection message handlers.
|
Package projection provides engine components that handle messages that are routed to projection message handlers. |
|
Package envelope provides a container for passing Dogma messages and their meta-data between components.
|
Package envelope provides a container for passing Dogma messages and their meta-data between components. |
|
Package fact contains structures that represents internal engine events.
|
Package fact contains structures that represents internal engine events. |