Package: /pkg/states

package states Import Path /pkg/states (on go.dev) Dependency Relation imports 4 packages, and imported by 22 packages

Involved Source Files d ss_basic.go Package states provides reusable state definitions. - basic - connected - disposed ss_connected.go ss_disposed.go states_utils.go

Package-Level Type Names (total 12)

/* sort by: alphabet | popularity */

type BasicStatesDef (struct) BasicStatesDef contains all the basic states. Fields (total 8) ErrHandlerTimeout string ErrHandlerTimeout indicates one of the state machine handlers has timed out. ErrNetwork string ErrNetwork indicates a generic network error. Healthcheck string Healthcheck is a periodic request making sure that the machine is still alive. Heartbeat string Heartbeat is a periodic state that ensures the integrity of the machine. Ready string Ready indicates the machine meets criteria to perform work. Start string Start indicates the machine should be working. Removing start can force stop the machine. StatesBase *am.StatesBase StatesBase.Exception string Exception is the only built-in state and mean a global error. All errors have to [State.Require] the Exception state. If [Machine.PanicToErr] is true, Exception will receive it. Methods (total 4) ( BasicStatesDef) Names() machine.S ( BasicStatesDef) SetNames(names machine.S) ( BasicStatesDef) SetStateGroups(groups map[string][]int, order []string) ( BasicStatesDef) StateGroups() (map[string][]int, []string) Implements (at least one exported) BasicStatesDef : github.com/pancsta/asyncmachine-go/pkg/machine.States As Types Of (only one) var BasicStates

type ConnectedGroupsDef (struct) ConnectedGroupsDef contains all the state groups of the Connected state schema. Fields (only one) Connected S As Types Of (only one) var ConnectedGroups

type ConnectedState = string (basic type)

type ConnectedStatesDef (struct) ConnectedStatesDef contains states for a connection status. Required states: - Start Fields (total 7) Connected ConnectedState Connecting ConnectedState Disconnected ConnectedState Disconnecting ConnectedState ErrConnecting ConnectedState ErrConnecting is a detailed connection error, eg no access. StatesBase *am.StatesBase StatesBase.Exception string Exception is the only built-in state and mean a global error. All errors have to [State.Require] the Exception state. If [Machine.PanicToErr] is true, Exception will receive it. Methods (total 4) ( ConnectedStatesDef) Names() machine.S ( ConnectedStatesDef) SetNames(names machine.S) ( ConnectedStatesDef) SetStateGroups(groups map[string][]int, order []string) ( ConnectedStatesDef) StateGroups() (map[string][]int, []string) Implements (at least one exported) ConnectedStatesDef : github.com/pancsta/asyncmachine-go/pkg/machine.States As Types Of (only one) var ConnectedStates

type ConnPoolGroupsDef (struct) ConnPoolGroupsDef contains all the state groups of the ConnPool state schema. Fields (only one) Connected S As Types Of (only one) var ConnPoolGroups

type ConnPoolState = string (basic type)

type ConnPoolStatesDef (struct) ConnPoolStatesDef contains states for a connection status. Required states: - Start Fields (total 8) Connected ConnPoolState ConnectedFully ConnPoolState Connecting ConnPoolState Disconnected ConnPoolState Disconnecting ConnPoolState ErrConnecting ConnPoolState ErrConnecting is a detailed connection error, eg no access. StatesBase *am.StatesBase StatesBase.Exception string Exception is the only built-in state and mean a global error. All errors have to [State.Require] the Exception state. If [Machine.PanicToErr] is true, Exception will receive it. Methods (total 4) ( ConnPoolStatesDef) Names() machine.S ( ConnPoolStatesDef) SetNames(names machine.S) ( ConnPoolStatesDef) SetStateGroups(groups map[string][]int, order []string) ( ConnPoolStatesDef) StateGroups() (map[string][]int, []string) Implements (at least one exported) ConnPoolStatesDef : github.com/pancsta/asyncmachine-go/pkg/machine.States As Types Of (only one) var ConnPoolStates

type DisposedGroupsDef (struct) DisposedGroupsDef contains all the state groups Disposed state machine. Fields (only one) Disposed S As Types Of (only one) var DisposedGroups

type DisposedHandlers (struct) Fields (only one) DisposedHandlers []am.HandlerDispose DisposedHandlers is a list of handler for pkg/states.DisposedStates Methods (total 4) (*DisposedHandlers) DisposedState(e *am.Event) (*DisposedHandlers) DisposingState(e *am.Event) (*DisposedHandlers) RegisterDisposalEnter(e *am.Event) bool (*DisposedHandlers) RegisterDisposalState(e *am.Event)

type DisposedStatesDef (struct) DisposedStatesDef contains all the states of the Disposed state machine. One a machine implements this state mixing, it HAS TO be disposed using the Disposing state (instead of [am.Machine.Dispose]). Required states: - Start Fields (total 5) Disposed string Disposed indicates that the machine has disposed allocated resources and is ready to be garbage collected by calling [am.Machine.Dispose]. Disposing string Disposing starts the machine disposal - first state-based and then calls [am.Machine.Dispose]. RegisterDisposal string RegisterDisposal registers a disposal handler passed under the DisposedArgHandler key. Requires [DisposedHandlers] to be bound prior to the registration. Handlers registered via RegisterDisposal can block. StatesBase *am.StatesBase StatesBase.Exception string Exception is the only built-in state and mean a global error. All errors have to [State.Require] the Exception state. If [Machine.PanicToErr] is true, Exception will receive it. Methods (total 4) ( DisposedStatesDef) Names() machine.S ( DisposedStatesDef) SetNames(names machine.S) ( DisposedStatesDef) SetStateGroups(groups map[string][]int, order []string) ( DisposedStatesDef) StateGroups() (map[string][]int, []string) Implements (at least one exported) DisposedStatesDef : github.com/pancsta/asyncmachine-go/pkg/machine.States As Types Of (only one) var DisposedStates

type S = am.S ([]) S is a type alias for a list of state names.

type State = am.State (struct) State is a type alias for a state definition. See [am.State].

Package-Level Functions (only one)

func AddErrConnecting(event *am.Event, mach *am.Machine, err error, args am.A) error AddErrConnecting wraps an error in the ErrConnecting sentinel and adds to a machine.

Package-Level Variables (total 19)

var BasicSchema machine.Schema

var BasicStates BasicStatesDef BasicStates contains all the states for the Basic machine.

var ConnectedGroups ConnectedGroupsDef ConnectedGroups contains all the state groups for the Connected state schema.

var ConnectedSchema machine.Schema ConnectedSchema represents all relations and properties of ConnectedStates.

var ConnectedStates ConnectedStatesDef ConnectedStates contains all the states for the Connected state schema.

var ConnPoolGroups ConnPoolGroupsDef ConnPoolGroups contains all the state groups for the ConnPool state schema.

var ConnPoolSchema machine.Schema ConnPoolSchema represents all relations and properties of ConnPoolStates.

var ConnPoolStates ConnPoolStatesDef ConnPoolStates contains all the states for the ConnPool state schema.

var DisposedArgHandler string DisposedArgHandler is the key for the disposal handler passed to the RegisterDisposal state. It needs to contain the EXPLICIT type of am.HandlerDispose, eg var dispose am.HandlerDispose = func(id string, ctx *am.StateCtx) { // ... }

var DisposedGroups DisposedGroupsDef DisposedGroups contains all the state groups for the Disposed machine.

var DisposedSchema machine.Schema DisposedSchema represents all relations and properties of DisposedStates.

var DisposedStates DisposedStatesDef DisposedStates contains all the states for the Disposed machine.

var ErrConnecting error

var Exception string Exception is a type alias for the exception state.

var SAdd func(states ...machine.S) machine.S SAdd is a func alias for merging lists of states.

var SchemaMerge func(schemas ...machine.Schema) machine.Schema SchemaMerge is a func alias for extending an existing state structure.

var StateAdd func(source machine.State, overlay machine.State) machine.State StateAdd is a func alias for adding to an existing state definition.

var StateSet func(source machine.State, auto bool, multi bool, overlay machine.State) machine.State StateSet is a func alias for replacing parts of an existing state definition.

var StatesUtilsFile string