machine

package

Go to main page

Versions in this module

v0

v0.10.0

Jan 16, 2025

Changes in this version

+ const SuffixEnd

+ const SuffixEnter

+ const SuffixExit

+ const SuffixState

v0.9.1

Jan 14, 2025

Changes in this version

type Machine

+ DisposeTimeout time.Duration

v0.9.0

Dec 15, 2024

Changes in this version

+ func AMerge[K comparable, V any](maps ...map[K]V) map[K]V

type Api

+ DetachHandlers func(handlers any) error

+ EvAdd func(event *Event, states S, args A) Result

+ EvAdd1 func(event *Event, state string, args A) Result

+ EvAddErr func(event *Event, err error, args A) Result

+ EvAddErrState func(event *Event, state string, err error, args A) Result

+ EvRemove func(event *Event, states S, args A) Result

+ EvRemove1 func(event *Event, state string, args A) Result

+ Tags func() []string

type Event

+ MachineId string

+ TransitionId string

+ func (e *Event) Clone() *Event

+ type HandlerDispose func(id string, ctx context.Context)

type Machine

+ func (m *Machine) EvAdd(event *Event, states S, args A) Result

+ func (m *Machine) EvAdd1(event *Event, states string, args A) Result

+ func (m *Machine) EvAddErr(event *Event, err error, args A) Result

+ func (m *Machine) EvAddErrState(event *Event, state string, err error, args A) Result

+ func (m *Machine) EvRemove(event *Event, states S, args A) Result

+ func (m *Machine) EvRemove1(event *Event, states string, args A) Result

+ func (m *Machine) HandleDispose(fn HandlerDispose)

+ type MutSource struct

+ MachId string

+ MachTime uint64

+ TxId string

type Mutation

+ Source *MutSource

type Step

+ FromStateIdx int

+ RelType Relation

+ ToStateIdx int

+ func (s *Step) GetFromState(index S) string

+ func (s *Step) GetToState(index S) string

type Time

+ func (t Time) Sum() uint64

v0.8.1

Dec 14, 2024

v0.8.0

Nov 13, 2024

Changes in this version

+ const EnvAmDebug

+ const EnvAmDetectEval

+ const EnvAmLog

+ const EnvAmLogFile

+ const EnvAmTestDebug

+ const EnvAmTraceFilter

+ const HandlerGlobal

+ var CtxKey = &CtxKeyName

+ var ErrDisposed = errors.New("machine disposed")

+ var ErrRelation = errors.New("relation error")

+ var ErrStateMissing = errors.New("missing states")

+ var LogArgs = []string

+ func IsHandler(states S, method string) (string, string)

+ func ListHandlers(handlers any, states S) ([]string, error)

+ func NewStateGroups[G any](groups G, mixins ...any) G

+ func NewStates[G States](states G) G

+ func StatesEqual(states1 S, states2 S) bool

type A

+ func Pass(args *AT) A

+ func PassMerge(existing A, args *AT) A

+ type AT struct

+ Err error

+ ErrTrace string

+ Panic *ExceptionArgsPanic

+ func ParseArgs(args A) *AT

+ type Api interface

+ ActiveStates func() S

+ Add func(states S, args A) Result

+ Add1 func(state string, args A) Result

+ AddErr func(err error, args A) Result

+ AddErrState func(state string, err error, args A) Result

+ Any func(states ...S) bool

+ Any1 func(state ...string) bool

+ BindHandlers func(handlers any) error

+ BindTracer func(tracer Tracer)

+ Clock func(states S) Clock

+ Ctx func() context.Context

+ DetachTracer func(tracer Tracer) bool

+ Dispose func()

+ Err func() error

+ Export func() *Serialized

+ GetLogId func() bool

+ GetStruct func() Struct

+ Has func(states S) bool

+ Has1 func(state string) bool

+ Id func() string

+ Index func(state string) int

+ Inspect func(states S) string

+ Is func(states S) bool

+ Is1 func(state string) bool

+ IsClock func(clock Clock) bool

+ IsDisposed func() bool

+ IsErr func() bool

+ IsTime func(time Time, states S) bool

+ Log func(msg string, args ...any)

+ NewStateCtx func(state string) context.Context

+ Not func(states S) bool

+ Not1 func(state string) bool

+ ParentId func() string

+ Remove func(states S, args A) Result

+ Remove1 func(state string, args A) Result

+ Set func(states S, args A) Result

+ SetLogId func(val bool)

+ SetLogLevel func(lvl LogLevel)

+ SetLogger func(logger Logger)

+ SetLoggerEmpty func(lvl LogLevel)

+ SetLoggerSimple func(logf func(format string, args ...any), level LogLevel)

+ StateNames func() S

+ StatesVerified func() bool

+ String func() string

+ StringAll func() string

+ Switch func(groups ...S) string

+ Tick func(state string) uint64

+ Time func(states S) Time

+ TimeSum func(states S) uint64

+ Tracers func() []Tracer

+ When func(states S, ctx context.Context) <-chan struct{}

+ When1 func(state string, ctx context.Context) <-chan struct{}

+ WhenArgs func(state string, args A, ctx context.Context) <-chan struct{}

+ WhenDisposed func() <-chan struct{}

+ WhenErr func(ctx context.Context) <-chan struct{}

+ WhenNot func(states S, ctx context.Context) <-chan struct{}

+ WhenNot1 func(state string, ctx context.Context) <-chan struct{}

+ WhenTicks func(state string, ticks int, ctx context.Context) <-chan struct{}

+ WhenTicksEq func(state string, tick uint64, ctx context.Context) <-chan struct{}

+ WhenTime func(states S, times Time, ctx context.Context) <-chan struct{}

+ type CtxBinding struct

+ Cancel context.CancelFunc

+ Ctx context.Context

+ type CtxKeyName struct

+ type CtxValue struct

+ Id string

+ State string

+ Tick uint64

type DefaultRelationsResolver

+ func (rr *DefaultRelationsResolver) NewStruct()

+ type HandlerFinal func(*Event)

+ type HandlerNegotiation func(*Event) bool

+ type LogArgsMapper func(args A) map[string]string

type Machine

+ func (m *Machine) AddBreakpoint(added S, removed S)

+ func (m *Machine) BindTracer(tracer Tracer)

+ func (m *Machine) CountActive(states S) int

+ func (m *Machine) DetachHandlers(handlers any) error

+ func (m *Machine) DetachTracer(tracer Tracer) bool

+ func (m *Machine) GetLogId() bool

+ func (m *Machine) Id() string

+ func (m *Machine) IsDisposed() bool

+ func (m *Machine) LogLvl(lvl LogLevel, msg string, args ...any)

+ func (m *Machine) MustBindHandlers(handlers any)

+ func (m *Machine) ParentId() string

+ func (m *Machine) SetLogId(val bool)

+ func (m *Machine) Toggle1(state string) Result

+ func (m *Machine) WillBe(states S) bool

+ func (m *Machine) WillBe1(state string) bool

+ func (m *Machine) WillBeRemoved(states S) bool

+ func (m *Machine) WillBeRemoved1(state string) bool

type RelationsResolver

+ NewStruct func()

type States

+ Names func() S

+ SetNames func(S)

+ type StatesBase struct

+ Exception string

+ func (b *StatesBase) Names() S

+ func (b *StatesBase) SetNames(names S)

type Time

+ func (t Time) Any1(idxs ...int) bool

+ func (t Time) String() string

type Transition

+ Api Api

+ TargetIndexes []int

v0.8.0-pre

Nov 13, 2024

v0.7.1

Nov 13, 2024

v0.7.0

Sep 14, 2024

Changes in this version

+ var ErrHandlerTimeout = errors.New("handler timeout")

+ func MockClock(mach *Machine, clock Clock)

+ type Clock map[string]uint64

+ type IndexStateCtx map[string][]context.CancelFunc

+ type IndexWhen map[string][]*WhenBinding

+ type IndexWhenArgs map[string][]*WhenArgsBinding

+ type IndexWhenTime map[string][]*WhenTimeBinding

type LogLevel

+ func EnvLogLevel(name string) LogLevel

type Machine

+ LogStackTrace bool

+ func (m *Machine) AddErrState(state string, err error, args A) Result

+ func (m *Machine) Index(state string) int

+ func (m *Machine) IsTime(t Time, states S) bool

+ func (m *Machine) PanicToErr(args A)

+ func (m *Machine) PanicToErrState(state string, args A)

+ func (m *Machine) SetLoggerEmpty(level LogLevel)

+ func (m *Machine) SetLoggerSimple(logf func(format string, args ...any), level LogLevel)

+ func (m *Machine) Tick(state string) uint64

type NoOpTracer

+ func (t *NoOpTracer) StructChange(machine *Machine, old Struct)

+ func (t *NoOpTracer) TransitionStart(transition *Transition)

+ func (t *NoOpTracer) VerifyStates(machine *Machine)

type Opts

+ DetectEval bool

+ DontLogStackTrace bool

type S

+ func SAdd(states ...S) S

+ type Serialized struct

+ ID string

+ StateNames S

+ Time Time

type State

+ Tags []string

+ func StateAdd(source State, overlay State) State

+ func StateSet(source State, auto, multi bool, overlay State) State

+ type StateIsActive map[string]bool

type Struct

+ func StructMerge(stateStructs ...Struct) Struct

+ type Time []uint64

+ func (t Time) Is(idxs []int) bool

+ func (t Time) Is1(idx int) bool

type Tracer

+ StructChange func(machine *Machine, old Struct)

+ TransitionStart func(transition *Transition)

+ VerifyStates func(machine *Machine)

type Transition

+ PreLogEntries []*LogEntry

+ QueueLen int

+ TimeAfter Time

+ TimeBefore Time

+ func (t *Transition) ClockAfter() Clock

+ func (t *Transition) ClockBefore() Clock

+ type WhenArgsBinding struct

+ type WhenBinding struct

+ Ch chan struct{}

+ Matched int

+ Negation bool

+ States StateIsActive

+ Total int

+ type WhenTimeBinding struct

+ Ch chan struct{}

+ Completed StateIsActive

+ Index map[string]int

+ Matched int

+ Times Time

+ Total int

v0.7.0-pre1

Sep 11, 2024

v0.6.5

Sep 11, 2024

v0.6.4

Jul 28, 2024

Changes in this version

+ type Export struct

+ Clocks Clocks

+ ID string

+ StateNames S

type Machine

+ func (m *Machine) Export(filepath string) error

+ func (m *Machine) Import(filepath string) error

type Result

+ const ResultNoOp

v0.6.3

Jul 16, 2024

Changes in this version

type Transition

+ LogEntriesLock sync.Mutex

v0.6.2

Jul 15, 2024

v0.6.1

Jul 12, 2024

v0.6.0

Jul 10, 2024

Changes in this version

+ const Any

+ type LogEntry struct

+ Level LogLevel

+ Text string

+ type NoOpTracer struct

+ func (t *NoOpTracer) End()

+ func (t *NoOpTracer) HandlerEnd(transition *Transition, emitter string, handler string)

+ func (t *NoOpTracer) HandlerStart(transition *Transition, emitter string, handler string)

+ func (t *NoOpTracer) Inheritable() bool

+ func (t *NoOpTracer) MachineDispose(machID string)

+ func (t *NoOpTracer) MachineInit(mach *Machine)

+ func (t *NoOpTracer) NewSubmachine(parent, mach *Machine)

+ func (t *NoOpTracer) QueueEnd(machine *Machine)

+ func (t *NoOpTracer) TransitionEnd(transition *Transition)

+ func (t *NoOpTracer) TransitionInit(transition *Transition)

type Tracer

+ QueueEnd func(machine *Machine)

v0.5.1

Jul 10, 2024

Changes in this version

type Transition

+ TAfter T

v0.5.0

Jun 2, 2024

Changes in this version

+ const EventException

+ const EventQueueAdd

+ const EventStructChange

+ const EventTransitionInit

+ const Exception

+ var ErrCanceled = errors.New("transition canceled")

+ var ErrInvalidArgs = errors.New("invalid arguments")

+ var ErrQueued = errors.New("transition queued")

+ var ErrStateUnknown = errors.New("state unknown")

+ var ErrTimeout = errors.New("timeout")

+ func IsActiveTick(tick uint64) bool

+ func NewArgsMapper(names []string, maxlen int) func(args A) map[string]string

+ func NormalizeID(id string) string

type DefaultRelationsResolver

+ func (rr *DefaultRelationsResolver) GetRelationsBetween(fromState, toState string) ([]Relation, error)

+ func (rr *DefaultRelationsResolver) GetRelationsOf(fromState string) ([]Relation, error)

type Event

+ func (e *Event) Mutation() *Mutation

+ func (e *Event) Transition() *Transition

type Machine

+ Disposed bool

+ ParentID string

+ QueueLimit int

+ StatesVerified bool

+ Tags []string

+ Tracers []Tracer

+ WhenDisposed chan struct{}

+ func NewCommon(ctx context.Context, id string, statesStruct Struct, stateNames S, ...) (*Machine, error)

+ func (m *Machine) Add1(state string, args A) Result

+ func (m *Machine) AddFromEv(states S, event *Event, args A) Result

+ func (m *Machine) Any1(states ...string) bool

+ func (m *Machine) CanAdd(states S) bool

+ func (m *Machine) CanRemove(states S) bool

+ func (m *Machine) CanSet(states S) bool

+ func (m *Machine) Clocks(states S) Clocks

+ func (m *Machine) DisposeForce()

+ func (m *Machine) Eval(ctx context.Context, fn func(), source string) bool

+ func (m *Machine) GetLogArgs() func(args A) map[string]string

+ func (m *Machine) GetStruct() Struct

+ func (m *Machine) Has1(state string) bool

+ func (m *Machine) HasStateChangedSince(clocks Clocks) bool

+ func (m *Machine) Is1(state string) bool

+ func (m *Machine) NewStateCtx(state string) context.Context

+ func (m *Machine) Not1(state string) bool

+ func (m *Machine) OnEvent(events []string, ctx context.Context) chan *Event

+ func (m *Machine) RegisterDisposalHandler(fn func())

+ func (m *Machine) Remove1(state string, args A) Result

+ func (m *Machine) RemoveFromEv(states S, event *Event, args A) Result

+ func (m *Machine) SetFromEv(states S, event *Event, args A) Result

+ func (m *Machine) SetLogArgs(matcher func(args A) map[string]string)

+ func (m *Machine) SetStruct(statesStruct Struct, names S) error

+ func (m *Machine) SetTestLogger(logf func(format string, args ...any), level LogLevel)

+ func (m *Machine) When1(state string, ctx context.Context) chan struct{}

+ func (m *Machine) WhenArgs(state string, args A, ctx context.Context) chan struct{}

+ func (m *Machine) WhenNot1(state string, ctx context.Context) chan struct{}

+ func (m *Machine) WhenQueueEnds(ctx context.Context) <-chan T

+ func (m *Machine) WhenTicks(state string, ticks int, ctx context.Context) chan struct{}

+ func (m *Machine) WhenTicksEq(state string, ticks int, ctx context.Context) chan struct{}

+ func (m *Machine) WhenTime(states S, times T, ctx context.Context) chan struct{}

type Mutation

+ Ctx context.Context

+ Eval func()

+ func (m Mutation) StateWasCalled(state string) bool

type MutationType

+ const MutationAdd

+ const MutationEval

+ const MutationRemove

+ const MutationSet

type Opts

+ LogArgs func(args A) map[string]string

+ Parent *Machine

+ ParentID string

+ QueueLimit int

+ Tags []string

+ Tracers []Tracer

+ func OptsWithDebug(opts *Opts) *Opts

+ func OptsWithParentTracers(opts *Opts, parent *Machine) *Opts

+ func OptsWithTracers(opts *Opts, tracers ...Tracer) *Opts

type RelationsResolver

+ GetRelationsBetween func(fromState, toState string) ([]Relation, error)

+ GetRelationsOf func(fromState string) ([]Relation, error)

type S

+ func SMerge(states ...S) S

+ type Step struct

+ Data any

+ FromState string

+ IsEnter bool

+ IsFinal bool

+ IsSelf bool

+ ToState string

+ Type StepType

+ type StepType int

+ const StepCancel

+ const StepHandler

+ const StepRelation

+ const StepRemove

+ const StepRemoveNotActive

+ const StepRequested

+ const StepSet

+ func (tt StepType) String() string

+ type Struct = map[string]State

+ func CloneStates(states Struct) Struct

+ type Tracer interface

+ End func()

+ HandlerEnd func(transition *Transition, emitter string, handler string)

+ HandlerStart func(transition *Transition, emitter string, handler string)

+ Inheritable func() bool

+ MachineDispose func(machID string)

+ MachineInit func(mach *Machine)

+ NewSubmachine func(parent, mach *Machine)

+ TransitionEnd func(transition *Transition)

+ TransitionInit func(transition *Transition)

type Transition

+ ClocksAfter Clocks

+ func (t *Transition) LogArgs() string

v0.3.1

Mar 1, 2024

v0.3.0

Mar 1, 2024

Changes in this version

+ const EventQueueEnd

+ const EventTick

+ const EventTransitionCancel

+ const EventTransitionEnd

+ const EventTransitionStart

+ type Clocks map[string]uint64

type LogLevel

+ func (l LogLevel) String() string

type Machine

+ func (m *Machine) GetLogLevel() LogLevel

+ func (m *Machine) GetLogger() Logger

+ func (m *Machine) Switch(states ...string) string

+ func (m *Machine) VerifyStates(states S) error

type Transition

+ ClocksBefore Clocks

+ ID string

+ LogEntries []string

v0.2.1

Jan 18, 2024

v0.2.0

Jan 18, 2024

v0.1.0

Jan 11, 2024

Changes in this version

+ func IsTimeAfter(time1, time2 T) bool

+ type A map[string]any

+ type DefaultRelationsResolver struct

+ Machine *Machine

+ Transition *Transition

+ func (rr *DefaultRelationsResolver) GetAutoMutation() *Mutation

+ func (rr *DefaultRelationsResolver) GetTargetStates(t *Transition, calledStates S) S

+ func (rr *DefaultRelationsResolver) SortStates(states S)

+ type Event struct

+ Args A

+ Machine *Machine

+ Name string

+ type ExceptionArgsPanic struct

+ CalledStates S

+ LastStep *TransitionStep

+ StackTrace []byte

+ StatesBefore S

+ Transition *Transition

+ type ExceptionHandler struct

+ func (eh *ExceptionHandler) ExceptionState(e *Event)

+ type HandlerBinding struct

+ Ready chan struct{}

+ type LogLevel int

+ const LogChanges

+ const LogDecisions

+ const LogEverything

+ const LogNothing

+ const LogOps

+ type Logger func(level LogLevel, msg string, args ...any)

+ type Machine struct

+ ActiveStates S

+ Ctx context.Context

+ Err error

+ HandlerTimeout time.Duration

+ ID string

+ LogID bool

+ LogLevel LogLevel

+ PanicToException bool

+ PrintExceptions bool

+ Queue []Mutation

+ Resolver RelationsResolver

+ StateNames S

+ States States

+ Transition *Transition

+ func New(ctx context.Context, states States, opts *Opts) *Machine

+ func (m *Machine) Add(states S, args A) Result

+ func (m *Machine) AddErr(err error) Result

+ func (m *Machine) AddErrStr(err string) Result

+ func (m *Machine) Any(states ...S) bool

+ func (m *Machine) BindHandlers(handlers any) (*HandlerBinding, error)

+ func (m *Machine) Clock(state string) uint64

+ func (m *Machine) Dispose()

+ func (m *Machine) DuringTransition() bool

+ func (m *Machine) From() S

+ func (m *Machine) GetRelationsBetween(fromState, toState string) []Relation

+ func (m *Machine) GetRelationsOf(fromState string) []Relation

+ func (m *Machine) GetStateCtx(state string) context.Context

+ func (m *Machine) Has(states S) bool

+ func (m *Machine) HasStateChanged(before S) bool

+ func (m *Machine) Inspect(states S) string

+ func (m *Machine) Is(states S) bool

+ func (m *Machine) IsClock(state string, tick uint64) bool

+ func (m *Machine) IsErr() bool

+ func (m *Machine) IsQueued(mutationType MutationType, states S, withoutArgsOnly bool, ...) int

+ func (m *Machine) Log(msg string, args ...any)

+ func (m *Machine) MustParseStates(states S) S

+ func (m *Machine) Not(states S) bool

+ func (m *Machine) On(events []string, ctx context.Context) chan *Event

+ func (m *Machine) Remove(states S, args A) Result

+ func (m *Machine) Set(states S, args A) Result

+ func (m *Machine) SetLogLevel(level LogLevel)

+ func (m *Machine) SetLogger(fn Logger)

+ func (m *Machine) String() string

+ func (m *Machine) StringAll() string

+ func (m *Machine) Time(states S) T

+ func (m *Machine) TimeSum(states S) uint64

+ func (m *Machine) To() S

+ func (m *Machine) When(states []string, ctx context.Context) chan struct{}

+ func (m *Machine) WhenErr(ctx context.Context) chan struct{}

+ func (m *Machine) WhenNot(states []string, ctx context.Context) chan struct{}

+ type Mutation struct

+ Args A

+ Auto bool

+ CalledStates S

+ Type MutationType

+ type MutationType int

+ const MutationTypeAdd

+ const MutationTypeRemove

+ const MutationTypeSet

+ func (m MutationType) String() string

+ type Opts struct

+ DontLogID bool

+ DontPanicToException bool

+ DontPrintExceptions bool

+ HandlerTimeout time.Duration

+ ID string

+ LogLevel LogLevel

+ Resolver RelationsResolver

+ type Relation int

+ const RelationAdd

+ const RelationAfter

+ const RelationRemove

+ const RelationRequire

+ func (r Relation) String(relation Relation) string

+ type RelationsResolver interface

+ GetAutoMutation func() *Mutation

+ GetTargetStates func(t *Transition, calledStates S) S

+ SortStates func(states S)

+ type Result int

+ const Canceled

+ const Executed

+ const Queued

+ func (r Result) String() string

+ type S []string

+ func DiffStates(states1 S, states2 S) S

+ type State struct

+ Add S

+ After S

+ Auto bool

+ Multi bool

+ Remove S

+ Require S

+ type States = map[string]State

+ type T []uint64

+ type Transition struct

+ Accepted bool

+ Enters S

+ Exits S

+ IsCompleted bool

+ Machine *Machine

+ Mutation *Mutation

+ StatesBefore S

+ StepIDs map[string]bool

+ Steps []TransitionStep

+ TargetStates S

+ func (t *Transition) Args() A

+ func (t *Transition) CalledStates() S

+ func (t *Transition) IsAuto() bool

+ func (t *Transition) String() string

+ func (t *Transition) Type() MutationType

+ type TransitionStep struct

+ Data any

+ FromState string

+ ID string

+ IsEnter bool

+ IsFinal bool

+ IsSelf bool

+ ToState string

+ Type TransitionStepType

+ type TransitionStepType int

+ const TransitionStepTypeCancel

+ const TransitionStepTypeNoSet

+ const TransitionStepTypeRelation

+ const TransitionStepTypeRemove

+ const TransitionStepTypeRequested

+ const TransitionStepTypeSet

+ const TransitionStepTypeTransition

+ func (tt TransitionStepType) String() string

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