package states

Import Path
	/docs/editors (on go.dev)

Dependency Relation
	imports 3 packages, and imported by 0 packages

Involved Source Files

	    schema.go
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type ServerGroupsDef (struct)
		ServerGroupsDef contains all the state groups of the Client state machine.

		Fields (only one)
			Rpc S
				Rpc is a group for RPC ready states.

		As Types Of (only one)
			  var ServerGroups

	 type ServerStatesDef (struct)
		ServerStatesDef contains all the states of the Client state machine.

		Fields (total 16)
			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.Start string
				Start indicates the machine should be working. Removing start can force
				stop the machine.

			ClientConnected string
				RPC client connected (technically)

			HandshakeDone string
				RPC client fully usable

			MetricSync string
				How many times the client requested a full sync.

			Ready string
				Ready - Client is fully connected to the server.

			RpcAccepting string
				setting up RPC accepting

			RpcReady string
				RPC is accepting or has accepted connections

			RpcStarting string
				Starting listening

			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.

			WebSocketTunnel string
				TCP tunneled over websocket

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


Package-Level Variables (total 3)

	  var ServerGroups ServerGroupsDef
		ServerGroups contains all the state groups for the Client machine.

	  var ServerSchema machine.Schema
		ServerSchema represents all relations and properties of ClientStates.

	  var ServerStates ServerStatesDef
		ServerStates contains all the states for the Client 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.