axdogma

func (*AggregateAdaptor) ApplyEvent ¶

func (a *AggregateAdaptor) ApplyEvent(d saga.Data, env ax.Envelope)

ApplyEvent updates d to reflect the fact that an event has occurred.

It may panic if env.Message does not implement ax.Event.

func (*AggregateAdaptor) HandleMessage ¶

func (a *AggregateAdaptor) HandleMessage(
	ctx context.Context,
	s ax.Sender,
	mctx ax.MessageContext,
	i saga.Instance,
) (err error)

HandleMessage handles a message for a particular saga instance.

func (*AggregateAdaptor) IsInstanceComplete ¶

func (a *AggregateAdaptor) IsInstanceComplete(ctx context.Context, i saga.Instance) (bool, error)

IsInstanceComplete returns true if the given instance is complete.

func (*AggregateAdaptor) MessageTypes ¶

func (a *AggregateAdaptor) MessageTypes() (tr ax.MessageTypeSet, mt ax.MessageTypeSet)

MessageTypes returns the set of messages that are routed to this saga.

tr is the set of "trigger" messages. If they can not be routed to an existing saga instance a new instance is created.

mt is the set of messages that are only routed to existing instances. If they can not be routed to an existing instance, the HandleNotFound() method is called instead.

func (*AggregateAdaptor) NewData ¶

func (a *AggregateAdaptor) NewData() saga.Data

NewData returns a pointer to a new zero-value instance of the saga's data type.

func (*AggregateAdaptor) PersistenceKey ¶

func (a *AggregateAdaptor) PersistenceKey() string

PersistenceKey returns a unique identifier for the saga.

The persistence key is used to relate persisted data with the saga implementation that owns it. Persistence keys should not be changed once a saga has active instances.

func (*AggregateMapper) DeleteMapping ¶

func (m *AggregateMapper) DeleteMapping(
	context.Context,
	saga.Saga,
	persistence.Tx,
	saga.Instance,
) error

DeleteMapping notifies the mapper that an instance has been completed, allowing it to remove it's mapping information, if necessary.

func (*AggregateMapper) MapMessageToInstance ¶

func (m *AggregateMapper) MapMessageToInstance(
	_ context.Context,
	sg saga.Saga,
	_ persistence.Tx,
	env ax.Envelope,
) (saga.InstanceID, bool, error)

MapMessageToInstance returns the ID of the saga instance that is the target of the given message.

It returns false if the message should be ignored.

func (*AggregateMapper) UpdateMapping ¶

func (m *AggregateMapper) UpdateMapping(
	context.Context,
	saga.Saga,
	persistence.Tx,
	saga.Instance,
) error

UpdateMapping notifies the mapper that an instance has been modified, allowing it to update it's mapping information, if necessary.

func (*IntegrationAdaptor) HandleMessage ¶

func (a *IntegrationAdaptor) HandleMessage(
	ctx context.Context,
	s ax.Sender,
	mctx ax.MessageContext,
) error

HandleMessage invokes application-defined logic that handles a message.

It may panic if env.Message is not one of the types described by MessageTypes().

func (*IntegrationAdaptor) MessageTypes ¶

func (a *IntegrationAdaptor) MessageTypes() ax.MessageTypeSet

MessageTypes returns the set of messages that the handler intends to handle.

The return value should be constant as it may be cached by various independent stages in the message pipeline.

func (*ProcessAdaptor) HandleMessage ¶

func (a *ProcessAdaptor) HandleMessage(
	ctx context.Context,
	s ax.Sender,
	mctx ax.MessageContext,
	i saga.Instance,
) (err error)

HandleMessage handles a message for a particular saga instance.

func (*ProcessAdaptor) IsInstanceComplete ¶

func (a *ProcessAdaptor) IsInstanceComplete(ctx context.Context, i saga.Instance) (bool, error)

IsInstanceComplete returns true if the given instance is complete.

func (*ProcessAdaptor) MessageTypes ¶

func (a *ProcessAdaptor) MessageTypes() (tr ax.MessageTypeSet, mt ax.MessageTypeSet)

MessageTypes returns the set of messages that are routed to this saga.

tr is the set of "trigger" messages. If they can not be routed to an existing saga instance a new instance is created.

mt is the set of messages that are only routed to existing instances. If they can not be routed to an existing instance, the HandleNotFound() method is called instead.

func (*ProcessAdaptor) NewData ¶

func (a *ProcessAdaptor) NewData() saga.Data

NewData returns a pointer to a new zero-value instance of the saga's data type.

func (*ProcessAdaptor) PersistenceKey ¶

func (a *ProcessAdaptor) PersistenceKey() string

PersistenceKey returns a unique identifier for the saga.

The persistence key is used to relate persisted data with the saga implementation that owns it. Persistence keys should not be changed once a saga has active instances.

func (*ProcessMapper) DeleteMapping ¶

func (m *ProcessMapper) DeleteMapping(
	context.Context,
	saga.Saga,
	persistence.Tx,
	saga.Instance,
) error

DeleteMapping notifies the mapper that an instance has been completed, allowing it to remove it's mapping information, if necessary.

func (*ProcessMapper) MapMessageToInstance ¶

func (m *ProcessMapper) MapMessageToInstance(
	ctx context.Context,
	sg saga.Saga,
	_ persistence.Tx,
	env ax.Envelope,
) (saga.InstanceID, bool, error)

MapMessageToInstance returns the ID of the saga instance that is the target of the given message.

It returns false if the message should be ignored.

func (*ProcessMapper) UpdateMapping ¶

func (m *ProcessMapper) UpdateMapping(
	context.Context,
	saga.Saga,
	persistence.Tx,
	saga.Instance,
) error

UpdateMapping notifies the mapper that an instance has been modified, allowing it to update it's mapping information, if necessary.

func (*ProjectionAdaptor) ApplyMessage ¶

func (a *ProjectionAdaptor) ApplyMessage(ctx context.Context, mctx ax.MessageContext) error

ApplyMessage invokes application-defined logic that updates the application state to reflect the occurrence of a message.

It may panic if env.Message is not one of the types described by MessageTypes().

func (*ProjectionAdaptor) MessageTypes ¶

func (a *ProjectionAdaptor) MessageTypes() ax.MessageTypeSet

MessageTypes returns the set of messages that the projector intends to handle.

The return value should be constant as it may be cached.

func (*ProjectionAdaptor) PersistenceKey ¶

func (a *ProjectionAdaptor) PersistenceKey() string

PersistenceKey returns a unique name for the projector.

The persistence key is used to relate persisted data with the projector implementation that owns it. Persistence keys should not be changed once a projection has been started.