states

Documentation

Index

• Constants
• Variables
• type S

Constants

const (
	ErrOnClient = ss.ErrOnClient

	Start         = ss.Start
	Ready         = ss.Ready
	HandshakeDone = ss.HandshakeDone
	Handshaking   = ss.Handshaking

	Connecting    = "Connecting"
	Connected     = "Connected"
	Disconnecting = "Disconnecting"
	Disconnected  = "Disconnected"
)

Variables

var (
	GroupConnected = S{Connecting, Connected, Disconnecting, Disconnected}
)

var Names = am.SAdd(ss.Names, S{
	Connecting,
	Connected,
	Disconnecting,
	Disconnected,
})

Names is an ordered list of all the state names.

var States = am.StructMerge(ss.States, am.Struct{
	ss.Start: {Add: S{Connecting}},
	ss.Ready: {
		Auto:    true,
		Require: S{HandshakeDone},
	},

	Connecting: {
		Require: S{Start},
		Remove:  GroupConnected,
	},
	Connected: {
		Require: S{Start},
		Remove:  GroupConnected,
		Add:     S{Handshaking},
	},
	Disconnecting: {
		Remove: GroupConnected,
	},
	Disconnected: {
		Auto:   true,
		Remove: GroupConnected,
	},

	HandshakeDone: am.StateAdd(ss.States[ss.HandshakeDone], am.State{
		Require: S{Connected},
	}),
})

States map defines relations and properties of states. Base on shared rpc states.

Types

type S

type S = am.S

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