helpers

Documentation

Overview

Package helpers provides experimental and unstable helpers.

Index

• func ErrFromCtxs(ctxs ...context.Context) error
• func FanOutIn(mach *am.Machine, name string, total, concurrency int, fn FanFn) (any, error)
• func NestedState(e *am.Event, strIDField string, machGetter func(id string) *am.Machine) (am.Result, <-chan struct{}, error)
• func RaceCtx[T *any](ctx context.Context, ch chan T) (T, error)
• func RelationsMatrix(mach *am.Machine) ([][]int, error)
• func TimeMatrix(machines []*am.Machine) ([]am.Time, error)
• func TransitionMatrix(tx, prevTx *am.Transition, index am.S) ([][]int, error)
• type FanFn
• type FanHandlers

Functions

func ErrFromCtxs

func ErrFromCtxs(ctxs ...context.Context) error

ErrFromCtxs returns the first non-nil error from a list of contexts.

func FanOutIn

func FanOutIn(
	mach *am.Machine, name string, total, concurrency int,
	fn FanFn,
) (any, error)

FanOutIn creates [total] number of state pairs of "Name1" and "Name1Done", as well as init and merge states ("Name", "NameDone"). [name] is treated as a namespace and can't have other states within. Retry can be achieved by adding the init state repetively. FanOutIn can be chained, but it should be called before any mutations or telemetry (as it changes the state struct). The returned handlers struct can be used to adjust the concurrency level.

func NestedState

func NestedState(
	e *am.Event, strIDField string, machGetter func(id string) *am.Machine,
) (am.Result, <-chan struct{}, error)

NestedState forwards the mutation to one of the composed submachines. Parent state should be a Multi state and only called directly (not from a relation). TODO test case, solve locking by passing the event to the submachine

func RaceCtx

func RaceCtx[T *any](ctx context.Context, ch chan T) (T, error)

func RelationsMatrix

func RelationsMatrix(mach *am.Machine) ([][]int, error)

func TimeMatrix

func TimeMatrix(machines []*am.Machine) ([]am.Time, error)

TimeMatrix returns a matrix of state clocks for the given machines.

func TransitionMatrix

func TransitionMatrix(tx, prevTx *am.Transition, index am.S) ([][]int, error)

Types

type FanFn

type FanFn func(num int, state, stateDone string)

type FanHandlers

type FanHandlers struct {
	Concurrency int
	AnyState    am.HandlerFinal
	GroupTasks  am.S
	GroupDone   am.S
}