package states

Import Path
	/pkg/node/states (on go.dev)

Dependency Relation
	imports 4 packages, and imported by 3 packages

Involved Source Files

	    ss_bootstrap.go
	    ss_node_client.go
	    ss_node_worker.go
	    ss_supervisor.go
Package-Level Type Names (total 7)

	/* sort by: alphabet | popularity */
	 type BootstrapStatesDef (struct)
		BootstrapStatesDef contains all the states of the Bootstrap state machine.
		The target state is WorkerAddr, activated by an aRPC client.

		Fields (total 12)
			BasicStatesDef *ssam.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.

			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.

			WorkerAddr string
				WorkerAddr - The awaited worker passed its connection details.

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

	 type ClientGroupsDef (struct)
		ClientGroupsDef contains all the state groups of the Client state machine.

		Fields (total 2)
			ConnectedGroupsDef *ss.ConnectedGroupsDef
			ConnectedGroupsDef.Connected S
		As Types Of (only one)
			  var ClientGroups

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

		Fields (total 24)
			BasicStatesDef *states.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.

			ConsumerStatesDef *ssrpc.ConsumerStatesDef
				inherit from ConsumerStatesDef

			ConsumerStatesDef.ServerPayload string
				ServerPayload RPC server delivers the requested payload to the Client.

			ErrSupervisor string
			ErrWorker string
			Exception string
			Ready string
				Ready - Client is connected to a worker and ready to delegate work and
				receive payloads.

			StatesBase *am.StatesBase
			SuperConnected string
			SuperConnecting string
			SuperDisconnected string
			SuperDisconnecting string
			SuperReady string
				SuperReady - Client is fully connected to the Supervisor.

			WorkerConnected string
			WorkerConnecting string
			WorkerDisconnected string
			WorkerDisconnecting string
			WorkerReady string
			WorkerRequested string
				WorkerRequested - Client has requested a NetMach from the Supervisor.

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

	 type SupervisorGroupsDef (struct)
		SupervisorGroupsDef contains all the state groups of the Supervisor state
		machine.

		Fields (total 5)
			ConnectedGroupsDef *ssam.ConnectedGroupsDef
			ConnectedGroupsDef.Connected S
			Errors S
				Errors list all possible errors of Supervisor.

			PoolNormalized S
				PoolNormalized async

			PoolStatus S
				PoolStatus are pool's possible statuses, 1 active at a time.

		As Types Of (only one)
			  var SupervisorGroups

	 type SupervisorStatesDef (struct)
		SupervisorStatesDef contains all the states of the Supervisor state machine.

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

			ClientConnected string
				ClientConnected - At least 1 client is connected to the supervisor.

			ClientDisconnected string
				ClientDisconnected - 1 Client has disconnected from the supervisor.

			ClientSendPayload string
				ClientSendPayload - payload delivered to the RPC server with for clients
				as mutation args.

			ErrPool string
			ErrWorker string
			ForkWorker string
				ForkWorker - Supervisor starts forking a new worker by creating a new aRPC
				server.

			ForkingWorker string
				ForkingWorker - Supervisor is forking a new worker.

			Heartbeat string
				Heartbeat checks the health of the worker pool and network connections.

			KillWorker string
			KillingWorker string
			ListWorkers string
				ListWorkers is a getter returning a list of workers via a channel, with
				filters.

			LocalRpcReady string
			NormalizingPool string
				NormalizingPool - Supervisor is re-spawning some workers.

			PoolNormalized string
				PoolNormalized - Supervisor has normalized the pool. Check PoolReady for
				the result.

			PoolReady string
				PoolReady - Minimum amount of workers are ready.

			PoolStarting string
				PoolStarting - Supervisor is starting workers to meet the pool definition.

			ProvideWorker string
				ProvideWorker - Client requests a new worker.

			PublicRpcReady string
			Ready string
				Ready - Supervisor is ready to accept new clients.

			SetWorker string
				SetWorker is a setter for a worker, which can also delete worker entries.

			StateSourceStatesDef *ssrpc.StateSourceStatesDef
				inherit from StateSourceStatesDef

			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.ErrOnClient string
				ErrOnClient indicates an error added on the Network Machine.

			SuperConnected string
			SuperDisconnected string
			SuperSendPayload string
				SuperSendPayload - payload delivered to the RPC server for supervisors
				as mutation args.

			WorkerConnected string
				WorkerForked - New worker connected to bootstrap.

			WorkerForked string
				WorkerForked - Supervisor has successfully forked a new worker.

			WorkerGone string
				WorkerGone - One of the workers has disconnected.

			WorkerIssues string
				WorkerIssues - Client complains about the worker.

			WorkerKilled string
			WorkerReady string
				WorkerReady - One of the workers become ready.

			WorkersAvailable string
				TODO all warm warkers ready
				PoolWarm string
				WorkersAvailable - There are some idle workers in the pool.

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

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

		Fields (only one)
			WorkStatus S
				WorkStatus represents work-related states, 1 active at a time. This group
				has to be bound by the implementation, e.g. using Add relation from custom
				work states.

		As Types Of (only one)
			  var WorkerGroups

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

		Fields (total 27)
			BasicStatesDef *ssam.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
				ClientConnected - NetMach is connected to a client.

			ClientSendPayload string
				Send payload to the client

			ErrClient string
			ErrSupervisor string
			ErrWork string
			ErrWorkTimeout string
			Idle string
			LocalRpcReady string
				LocalRpcReady - Supervisor RPC server is ready for connections.

			PublicRpcReady string
				PublicRpcReady - Client RPC server is ready for connections.

			Ready string
				Ready - NetMach is able to perform work.

			RpcReady string
				RpcReady - both RPC servers are ready.

			ServeClient string
				ServeClient - NetMach is requested to accept a connection from client
				am.A["id"].

			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.

			SuperConnected string
				SuperConnected - NetMach is connected to the Supervisor.

			SuperSendPayload string
				Send payload to the supervisor

			WorkReady string
			WorkRequested string
			Working 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 11)

	  var BootstrapSchema machine.Schema
		BootstrapSchema represents all relations and properties of
		BootstrapStatesDef.

	  var BootstrapStates BootstrapStatesDef
		BootstrapStates contains all the states for the Bootstrap machine.

	  var ClientGroups ClientGroupsDef
		ClientGroups contains all the state groups for the Client machine.

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

	  var ClientStates ClientStatesDef
		ClientStates contains all the states for the Client machine.

	  var SupervisorGroups SupervisorGroupsDef
		SupervisorGroups contains all the state groups for the Supervisor machine.

	  var SupervisorSchema machine.Schema
		SupervisorSchema represents all relations and properties of SupervisorStates.

	  var SupervisorStates SupervisorStatesDef
		SupervisorStates contains all the states for the Supervisor machine.

	  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.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.