package states

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

Dependency Relation
	imports 3 packages, and imported by one package

Involved Source Files

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

	/* sort by: alphabet | popularity */
	 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].

	 type WorkerGroupsDef (struct)
		WorkerGroupsDef contains all the state groups of the NetMach state machine.

		Fields (only one)
			Values S
				Values group contains mutually exclusive values.

		As Types Of (only one)
			  var WorkerGroups

	 type WorkerStatesDef (struct)
		WorkerStatesDef contains all the states of the NetMach state machine.

		Fields (total 16)
			BasicStatesDef *ssam.BasicStatesDef
				inherit from BasicSchema

			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.

			CallOp string
			Event 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.

			StateSourceStatesDef *ssrpc.StateSourceStatesDef
				inherit from StateSourceStatesDef

			StateSourceStatesDef.ErrOnClient string
				ErrOnClient indicates an error added on the Network Machine.

			Value1 string
			Value2 string
			Value3 string
		Methods (total 4)
			( WorkerStatesDef) Names() machine.S
			( WorkerStatesDef) SetNames(names machine.S)
			( WorkerStatesDef) SetStateGroups(groups map[string][]int, order []string)
			( WorkerStatesDef) StateGroups() (map[string][]int, []string)
		Implements (at least one exported)
			 WorkerStatesDef : github.com/pancsta/asyncmachine-go/pkg/machine.States
		As Types Of (only one)
			  var WorkerStates


Package-Level Variables (total 6)

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

	  var Ready string
		Ready is a type alias for the Ready state.

	  var Start string
		Start is a type alias for the Start state.

	  var WorkerGroups WorkerGroupsDef
		WorkerGroups contains all the state groups for the NetMach machine.

	  var WorkerSchema machine.Schema
		WorkerSchema represents all relations and properties of WorkerStates.

	  var WorkerStates WorkerStatesDef
		WorkerStates contains all the states for the NetMach machine.

The pages are generated with Golds v0.8.4. (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.