hsm

package module

Go to main page

Versions in this module

v1

v1.3.2

Jul 19, 2026

v1.3.1

Jul 6, 2026

Changes in this version

+ var AttributeKind = kind.Make(ElementKind)

+ var EntryPointKind = kind.Make(PseudostateKind)

+ var ErrInvalidAttributeType = errors.New("invalid attribute type")

+ var ErrUnknownAttribute = errors.New("unknown attribute")

+ var ExitPointKind = kind.Make(PseudostateKind)

+ var ObservationEvent = Event

+ var ObservationKind = kind.Make(ElementKind)

+ var OperationKind = kind.Make(ElementKind)

+ var SubmachineStateKind = kind.Make(StateKind)

+ func AttributeType[T any]() reflect.Type

+ type Completion <-chan struct

+ func (completion Completion) Err() error

+ func (completion Completion) Wait() error

+ type ComposableModel interface

+ type DefaultModelFinalizer struct

+ func (DefaultModelFinalizer) Finalize(model *Model) *FinalizedModel

+ type DefaultModelValidator struct

+ func (DefaultModelValidator) Validate(model *Model)

+ type FinalizedModel struct

+ func Redefine(model FinalizedModel, args ...any) FinalizedModel

+ func (state FinalizedModel) Activities() []string

+ func (state FinalizedModel) Entry() []string

+ func (state FinalizedModel) Exit() []string

type Group

+ func (group *Group) Snapshots() []Snapshot

+ func (group *Group) States() []string

type Model

+ func InlineModel(redefinableElements ...RedefinableElement) Model

+ func (model *Model) TransitionSnapshots() []TransitionSnapshot

+ type ModelFinalizer interface

+ Finalize func(model *Model) *FinalizedModel

+ type ModelFinalizerFunc func(model *Model) *FinalizedModel

+ func (fn ModelFinalizerFunc) Finalize(model *Model) *FinalizedModel

+ type ModelValidator interface

+ Validate func(model *Model)

+ type ModelValidatorFunc func(model *Model)

+ func (fn ModelValidatorFunc) Validate(model *Model)

+ type ObservationData struct

+ Event Event

+ Occurrence string

+ Time time.Time

type RedefinableElement

+ func EntryPoint[T stringLike](name T, partialElements ...RedefinableElement) RedefinableElement

+ func ExitPoint[T stringLike](name T, partialElements ...RedefinableElement) RedefinableElement

+ func Finalizer(finalizer any) RedefinableElement

+ func Observe[T Instance](observer func(context.Context, T, Event), targets ...any) RedefinableElement

+ func SubmachineState[T stringLike, M ComposableModel](name T, machine M, partialElements ...RedefinableElement) RedefinableElement

+ func TransitionType(kindValue uint64) RedefinableElement

+ func Validator(validator any) RedefinableElement

type Snapshot

+ Transitions []TransitionSnapshot

+ func TakeSnapshots(ctx context.Context, hsm Instance) []Snapshot

+ type TransitionSnapshot struct

+ Events []string

+ Guard bool

+ Kind uint64

+ Name string

+ Source string

+ Target string

v1.3.0

May 24, 2026

Changes in this version

+ func IsKind(k uint64, bases ...uint64) bool

+ func MakeKind(bases ...uint64) uint64

type Group

+ func MakeGroup(values ...any) *Group

v1.2.7

May 24, 2026

v1.2.6

May 23, 2026

v1.2.5

May 23, 2026

v1.2.4

May 22, 2026

v1.2.3

May 22, 2026

Changes in this version

type Config

+ Queue Queue

+ type Queue struct

+ Len func(ctx context.Context) int

+ Pop func(ctx context.Context) (Event, bool)

+ Push func(ctx context.Context, event Event)

v1.2.2

Mar 19, 2026

v1.2.1

Mar 19, 2026

v1.2.0

Mar 19, 2026

Changes in this version

+ type EventSnapshot struct

+ Guard bool

+ Kind uint64

+ Name string

+ Schema any

+ Target string

v1.1.0

Mar 10, 2026

Changes in this version

type RedefinableElement

+ func At[T Instance](expr func(ctx context.Context, hsm T, event Event) time.Time) RedefinableElement

v1.0.8

Mar 10, 2026

Changes in this version

+ var DefaultClock = Clock

+ type Clock struct

+ After func(time.Duration) <-chan time.Time

+ NewTimer func(time.Duration) *time.Timer

type Config

+ Clock Clock

type Group

+ func (group *Group) Clock() Clock

type Instance

+ Clock func() Clock

v1.0.7

Feb 11, 2026

v1.0.6

Feb 3, 2026

Changes in this version

+ var ErrAlreadyStarted = errors.New("hsm already started")

+ type ExpressionFunc func(ctx context.Context, hsm T, event Event) bool

+ type Group struct

+ func NewGroup(instances ...Instance) *Group

+ func (group *Group) Call(ctx context.Context, name string, args ...any) (any, error)

+ func (group *Group) Context() context.Context

+ func (group *Group) Get(name string) (any, bool)

+ func (group *Group) Instances() []Instance

+ func (group *Group) Set(ctx context.Context, name string, value any) <-chan struct{}

+ func (group *Group) State() string

+ type OperationFunc func(ctx context.Context, hsm T, event Event)

v1.0.5

Feb 3, 2026

v1.0.4

Feb 3, 2026

v1.0.3

Feb 3, 2026

Changes in this version

+ var CallEventKind = kind.Make(EventKind)

+ var ChangeEventKind = kind.Make(EventKind)

+ var DeepHistoryKind = kind.Make(PseudostateKind)

+ var ErrInvalidOperation = errors.New("invalid operation")

+ var ErrMissingOperation = errors.New("missing operation")

+ var ShallowHistoryKind = kind.Make(PseudostateKind)

+ func Call(ctx context.Context, hsm Instance, name string, args ...any) (any, error)

+ func Get(ctx context.Context, hsm Instance, name string) (any, bool)

+ func Set(ctx context.Context, hsm Instance, name string, value any) <-chan struct

+ type AttributeChange struct

+ Name string

+ New any

+ Old any

+ type CallData struct

+ Args []any

+ Name string

type Instance

+ Call func(ctx context.Context, name string, args ...any) (any, error)

+ Get func(name string) (any, bool)

+ Set func(ctx context.Context, name string, value any) <-chan struct{}

type RedefinableElement

+ func Attribute(name string, maybeDefault ...any) RedefinableElement

+ func DeepHistory[T interface{ ... }](elementOrName T, partialElements ...RedefinableElement) RedefinableElement

+ func OnCall(name string) RedefinableElement

+ func OnSet(name string) RedefinableElement

+ func Op(name string, fn any) RedefinableElement

+ func OperationDef(name string, fn any) RedefinableElement

+ func ShallowHistory[T interface{ ... }](elementOrName T, partialElements ...RedefinableElement) RedefinableElement

type Snapshot

+ Attributes map[string]any

v1.0.2

Feb 2, 2026

v1.0.1

Feb 2, 2026

v1.0.0

Feb 2, 2026

Changes in this version

+ const Version

+ var AnyEvent = Event

+ var BehaviorKind = kind.Make(ElementKind)

+ var ChoiceKind = kind.Make(PseudostateKind)

+ var CompletionEventKind = kind.Make(EventKind)

+ var ConcurrentKind = kind.Make(BehaviorKind)

+ var ConstraintKind = kind.Make(ElementKind)

+ var CustomKind = kind.Make(ElementKind)

+ var ElementKind = kind.Make()

+ var ErrInvalidState = errors.New("invalid state")

+ var ErrMissingHSM = errors.New("missing hsm in context")

+ var ErrNilHSM = errors.New("hsm is nil")

+ var ErrorEvent = Event

+ var ErrorEventKind = kind.Make(CompletionEventKind)

+ var EventKind = kind.Make(ElementKind)

+ var ExternalKind = kind.Make(TransitionKind)

+ var FinalEvent = Event

+ var FinalStateKind = kind.Make(StateKind)

+ var InfiniteDuration = time.Duration(-1)

+ var InitialEvent = Event

+ var InitialKind = kind.Make(PseudostateKind)

+ var InternalKind = kind.Make(TransitionKind)

+ var Keys = struct{ ... }

+ var LocalKind = kind.Make(TransitionKind)

+ var NamespaceKind = kind.Make(ElementKind)

+ var NullKind = kind.Make()

+ var PseudostateKind = kind.Make(VertexKind)

+ var RegionKind = kind.Make(ElementKind)

+ var SelfKind = kind.Make(TransitionKind)

+ var StateKind = kind.Make(VertexKind, NamespaceKind)

+ var StateMachineKind = kind.Make(ConcurrentKind, NamespaceKind)

+ var TimeEventKind = kind.Make(EventKind)

+ var TransitionKind = kind.Make(ElementKind)

+ var VertexKind = kind.Make(ElementKind)

+ func AfterDispatch(ctx context.Context, hsm Instance, event Event) <-chan struct

+ func AfterEntry(ctx context.Context, hsm Instance, state string) <-chan struct

+ func AfterExecuted(ctx context.Context, hsm Instance, state string) <-chan struct

+ func AfterExit(ctx context.Context, hsm Instance, state string) <-chan struct

+ func AfterProcess(ctx context.Context, hsm Instance, maybeEvent ...Event) <-chan struct

+ func DispatchAll(ctx context.Context, event Event) <-chan struct

+ func DispatchTo(ctx context.Context, event Event, maybeIds ...string) <-chan struct

+ func Dispatch[T context.Context](ctx T, hsm Instance, event Event) <-chan struct

+ func ID(hsm Instance) string

+ func IsAncestor(current, target string) bool

+ func LCA(a, b string) string

+ func Match(value string, patterns ...string) bool

+ func Name(hsm Instance) string

+ func New[T Instance](sm T, model *Model, maybeConfig ...Config) T

+ func QualifiedName(hsm Instance) string

+ func Restart(ctx context.Context, hsm Instance, maybeData ...any) <-chan struct

+ func Start[T Instance](ctx context.Context, sm T, maybeData ...any) T

+ func Started[T Instance](ctx context.Context, sm T, model *Model, maybeConfig ...Config) T

+ func Stop(ctx context.Context, hsm Instance) <-chan struct

+ type Config struct

+ ActivityTimeout time.Duration

+ Data any

+ ID string

+ Name string

+ type Element interface

+ Id func() string

+ Kind func() uint64

+ Name func() string

+ Owner func() string

+ QualifiedName func() string

+ type Event struct

+ Data any

+ ID string

+ Kind uint64

+ Name string

+ Schema any

+ Source string

+ Target string

+ func (e Event) WithData(data any) Event

+ func (e Event) WithDataAndID(data any, id string) Event

+ type EventDetail struct

+ Event string

+ Guard bool

+ Schema any

+ Target string

+ type Expression func(ctx context.Context, hsm T, event Event) bool

+ type HSM struct

+ type Instance interface

+ Context func() context.Context

+ State func() string

+ func FromContext(ctx context.Context) (Instance, bool)

+ func InstancesFromContext(ctx context.Context) ([]Instance, bool)

+ type Model struct

+ DeferredMap map[string]map[string]struct{}

+ TransitionMap map[string]map[string][]*transition

+ func Define(name string, redefinableElements ...RedefinableElement) Model

+ func (model *Model) Members() map[string]Element

+ func (state *Model) Activities() []string

+ func (state *Model) Entry() []string

+ func (state *Model) Exit() []string

+ type Operation func(ctx context.Context, hsm T, event Event)

+ type RedefinableElement = func(model *Model, stack []Element) Element

+ func Activity[T Instance](funcs ...func(ctx context.Context, hsm T, event Event)) RedefinableElement

+ func After[T Instance](expr func(ctx context.Context, hsm T, event Event) time.Duration) RedefinableElement

+ func Choice[T interface{ ... }](elementOrName T, partialElements ...RedefinableElement) RedefinableElement

+ func Defer[T interface{ ... }](events ...T) RedefinableElement

+ func Effect[T Instance](funcs ...func(ctx context.Context, hsm T, event Event)) RedefinableElement

+ func Entry[T Instance](funcs ...func(ctx context.Context, hsm T, event Event)) RedefinableElement

+ func Every[T Instance](expr func(ctx context.Context, hsm T, event Event) time.Duration) RedefinableElement

+ func Exit[T Instance](funcs ...func(ctx context.Context, hsm T, event Event)) RedefinableElement

+ func Final(name string) RedefinableElement

+ func Guard[T Instance](fn func(ctx context.Context, hsm T, event Event) bool) RedefinableElement

+ func Initial(partialElements ...RedefinableElement) RedefinableElement

+ func On[T interface{ ... }](events ...T) RedefinableElement

+ func Source[T interface{ ... }](nameOrPartialElement T) RedefinableElement

+ func State(name string, partialElements ...RedefinableElement) RedefinableElement

+ func Target[T interface{ ... }](nameOrPartialElement T) RedefinableElement

+ func Transition[T interface{ ... }](nameOrPartialElement T, partialElements ...RedefinableElement) RedefinableElement

+ func When[T Instance](expr func(ctx context.Context, hsm T, event Event) <-chan struct{}) RedefinableElement

+ type Snapshot struct

+ Events []EventDetail

+ ID string

+ QualifiedName string

+ QueueLen int

+ State string

+ func TakeSnapshot(ctx context.Context, hsm Instance) Snapshot

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL