package states

Import Path
	github.com/pancsta/asyncmachine-go/tools/relay/states (on go.dev)

Dependency Relation
	imports 4 packages, and imported by 2 packages

Involved Source Files

	  d ss_relay.go
		Package states contains a stateful schema-v2 for Relay.
		Bootstrapped with am-gen. Edit manually or re-gen & merge.
Package-Level Type Names (total 2)

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

		As Types Of (only one)
			  var RelayGroups

	 type RelayStatesDef (struct)
		RelayStatesDef contains all the states of the Relay state machine.

		Fields (total 18)
			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.

			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.

			ServerStatesDef *ssdbg.ServerStatesDef
				inherit from [ssdbg.ServerStatesDef]

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


Package-Level Variables (total 3)

	  var RelayGroups RelayGroupsDef
		RelayGroups contains all the state groups for the Relay machine.

	  var RelaySchema machine.Schema
		RelaySchema represents all relations and properties of RelayStates.

	  var RelayStates RelayStatesDef
		RelayStates contains all the states for the Relay machine.

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.