package states

Import Path
	github.com/pancsta/asyncmachine-go/examples/mach_template/states (on go.dev)

Dependency Relation
	imports 2 packages, and imported by one package

Involved Source Files

	  d ss_mach_template.go
		Package states contains a stateful schema-v2 for MachTemplate.
		Bootstrapped with am-gen. Edit manually or re-gen & merge.

	    states_utils.go
Package-Level Type Names (total 4)

	/* sort by: alphabet | popularity */
	 type MachTemplateGroupsDef (struct)
		MachTemplateGroupsDef contains all the state groups MachTemplate state machine.

		Fields (total 4)
			ConnectedGroupsDef *ss.ConnectedGroupsDef
			ConnectedGroupsDef.Connected states.S
			Group1 S
			Group2 S
		As Types Of (only one)
			  var MachTemplateGroups

	 type MachTemplateStatesDef (struct)
		MachTemplateStatesDef contains all the states of the MachTemplate state machine.

		Fields (total 25)
			Bar string
			BasicStatesDef *ss.BasicStatesDef
				inherit from BasicStatesDef

			BasicStatesDef.ErrHandlerTimeout string
				ErrHandlerTimeout indicates one of the state machine handlers has timed
				out.

			BasicStatesDef.ErrNetwork string
				ErrNetwork indicates a generic network error.

			BasicStatesDef.Healthcheck string
				Healthcheck is a periodic request making sure that the machine is still
				alive.

			BasicStatesDef.Heartbeat string
				Heartbeat is a periodic state that ensures the integrity of the machine.

			BasicStatesDef.Ready string
				Ready indicates the machine meets criteria to perform work.

			BasicStatesDef.Start string
				Start indicates the machine should be working. Removing start can force
				stop the machine.

			Baz string
			BazDone string
			Channel string
			ConnectedStatesDef *ss.ConnectedStatesDef
				inherit from ConnectedStatesDef

			ConnectedStatesDef.Connected states.ConnectedState
			ConnectedStatesDef.Connecting states.ConnectedState
			ConnectedStatesDef.Disconnected states.ConnectedState
			ConnectedStatesDef.Disconnecting states.ConnectedState
			ConnectedStatesDef.ErrConnecting states.ConnectedState
				ErrConnecting is a detailed connection error, eg no access.

			DisposedStatesDef *ss.DisposedStatesDef
				inherit from DisposedStatesDef

			DisposedStatesDef.Disposed string
				Disposed indicates that the machine has disposed allocated resoruces
				and is ready to be garbage collected by calling [am.Machine.Dispose].

			DisposedStatesDef.Disposing string
				Disposing indicates that the machine is during the disposal process.

			DisposedStatesDef.RegisterDisposal string
				RegisterDisposal registers a disposal handler passed under the
				DisposedArgHandler key.

			ErrExample string
			Foo string
			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)
			( MachTemplateStatesDef) Names() machine.S
			( MachTemplateStatesDef) SetNames(names machine.S)
			( MachTemplateStatesDef) SetStateGroups(groups map[string][]int, order []string)
			( MachTemplateStatesDef) StateGroups() (map[string][]int, []string)
		Implements (at least one exported)
			 MachTemplateStatesDef : github.com/pancsta/asyncmachine-go/pkg/machine.States
		As Types Of (only one)
			  var MachTemplateStates

	 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 Variables (total 8)

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

	  var MachTemplateGroups MachTemplateGroupsDef
		MachTemplateGroups contains all the state groups for the MachTemplate machine.

	  var MachTemplateSchema machine.Schema
		MachTemplateSchema represents all relations and properties of MachTemplateStates.

	  var MachTemplateStates MachTemplateStatesDef
		MachTemplateStates contains all the states for the MachTemplate machine.

	  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.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.