package states

Import Path
	/examples/mach_template/states (on go.dev)

Dependency Relation
	imports 3 packages, and imported by one package


Involved Source Files

	
		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:  |  */
	
		MachTemplateGroupsDef contains all the state groups MachTemplate state machine.

		
			ConnectedGroupsDef *ssam.ConnectedGroupsDef
			ConnectedGroupsDef.Connected S
			Group1 S
			Group2 S
		
			  var MachTemplateGroups


	
		MachTemplateStatesDef contains all the states of the MachTemplate state machine.

		
			Bar string
			
				inherit from BasicStatesDef

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

			
				ErrNetwork indicates a generic network error.

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

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

			
				Ready indicates the machine meets criteria to perform work.

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

			Baz string
			BazDone string
			Channel string
			
				inherit from ConnectedStatesDef

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

			
				inherit from DisposedStatesDef

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

			
				Disposing starts the machine disposal - first state-based and then calls
				[am.Machine.Dispose].

			
				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.

			ErrExample string
			Foo string
			StatesBase *am.StatesBase
			
				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.

			
				inherit from StateSourceStatesDef

			
				ErrOnClient indicates an error added on the Network Machine.

		
			( MachTemplateStatesDef) Names() machine.S
			( MachTemplateStatesDef) SetNames(names machine.S)
			( MachTemplateStatesDef) SetStateGroups(groups map[string][]int, order []string)
			( MachTemplateStatesDef) StateGroups() (map[string][]int, []string)
		
			 MachTemplateStatesDef : github.com/pancsta/asyncmachine-go/pkg/machine.States
		
			  var MachTemplateStates


	
		S is a type alias for a list of state names.


	
		State is a type alias for a state definition. See [am.State].




Package-Level Variables (total 6)


	
		Exception is a type alias for the Exception state.


	
		MachTemplateGroups contains all the state groups for the MachTemplate machine.


	
		MachTemplateSchema represents all relations and properties of MachTemplateStates.


	
		MachTemplateStates contains all the states for the MachTemplate machine.


	
		Ready is a type alias for the Ready state.


	
		Start is a type alias for the Start state.