package states
Import Path
/pkg/rpc/states (on go.dev)
Dependency Relation
imports 3 packages, and imported by 24 packages
Involved Source Files
ss_rpc.go
Package-Level Type Names (total 11)
ClientGroupsDef contains all the state groups of the Client state machine.
ConnectedGroupsDef *ss.ConnectedGroupsDef
ConnectedGroupsDef.Connected S
SharedGroupsDef *SharedGroupsDef
Work represents work-related states, 1 active at a time.
var ClientGroups
ClientStatesDef contains all the states of the Client state machine.
TODO should be ErrCallRetry, req:Exception
ConnectedStatesDef.Connected states.ConnectedState
ConnectedStatesDef.Connecting states.ConnectedState
ConnectedStatesDef.Disconnected states.ConnectedState
ConnectedStatesDef.Disconnecting states.ConnectedState
ErrConnecting is a detailed connection error, eg no access.
TODO should be ErrConnRetry, req:Exception
inherit from ConnectedStatesDef
HandshakeDone string
How many times the client requested a full sync.
Ready indicates the remote source (worker) is ready to be used.
RetryingCall string
RetryingConn string
ServerDelivering is an optional indication that the server has started a
data transmission to the Client.
ServerPayload allows the Consumer to bind his handlers and receive data
from the Server via the Client.
inherit from BasicStatesDef
ErrHandlerTimeout indicates one of the state machine handlers has timed
out.
ErrNetwork indicates a generic network error.
Healthcheck is a periodic request making sure that the machine is still
alive.
Heartbeat is a periodic state that ensures the integrity of the machine.
Start indicates the machine should be working. Removing start can force
stop the machine.
SharedStatesDef.ErrDelivery string
SharedStatesDef.ErrNetworkTimeout string
SharedStatesDef.ErrRpc string
SharedStatesDef.Handshaking string
inherit from rpc/StateSourceStatesDef (for REPL)
ErrOnClient indicates an error added on the Network Machine.
shadow duplicated StatesBase
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.
( ClientStatesDef) Names() machine.S
( ClientStatesDef) SetNames(names machine.S)
( ClientStatesDef) SetStateGroups(groups map[string][]int, order []string)
( ClientStatesDef) StateGroups() (map[string][]int, []string)
ClientStatesDef : github.com/pancsta/asyncmachine-go/pkg/machine.States
var ClientStates
ConsumerHandlers is the required interface for Consumer's state handlers.
( ConsumerHandlers) ServerPayloadState(e *am.Event)
*github.com/pancsta/asyncmachine-go/pkg/rpc.Client
*github.com/pancsta/asyncmachine-go/pkg/node.Client
ConsumerStatesDef contains all the states of the Consumer state machine.
Exception string
ServerPayload RPC server delivers the requested payload to the Client.
StatesBase *am.StatesBase
( ConsumerStatesDef) Names() machine.S
( ConsumerStatesDef) SetNames(names machine.S)
( ConsumerStatesDef) SetStateGroups(groups map[string][]int, order []string)
( ConsumerStatesDef) StateGroups() (map[string][]int, []string)
ConsumerStatesDef : github.com/pancsta/asyncmachine-go/pkg/machine.States
var ConsumerStates
MuxGroupsDef contains all the state groups of the Mux state machine.
var MuxGroups
MuxStatesDef contains all the states of the Mux state machine.
The target state is PortInfo, activated by an aRPC client.
inherit from BasicStatesDef
ErrHandlerTimeout indicates one of the state machine handlers has timed
out.
ErrNetwork indicates a generic network error.
Healthcheck is a periodic request making sure that the machine is still
alive.
Heartbeat is a periodic state that ensures the integrity of the machine.
Start indicates the machine should be working. Removing start can force
stop the machine.
stateless event
HasClients string
NewServerErr - new server returned an error. The mux is still running.
TODO refac
Ready - mux is ready to accept new clients.
shadow duplicated StatesBase
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.
( MuxStatesDef) Names() machine.S
( MuxStatesDef) SetNames(names machine.S)
( MuxStatesDef) SetStateGroups(groups map[string][]int, order []string)
( MuxStatesDef) StateGroups() (map[string][]int, []string)
MuxStatesDef : github.com/pancsta/asyncmachine-go/pkg/machine.States
var MuxStates
ServerGroupsDef contains all the state groups of the Client state machine.
Rpc is a group for RPC ready states.
SharedGroupsDef *SharedGroupsDef
Work represents work-related states, 1 active at a time.
var ServerGroups
ServerStatesDef contains all the states of the Client state machine.
RPC client connected (technically)
RPC client fully usable
How many times the client requested a full sync.
Ready - Client is fully connected to the server.
setting up RPC accepting
RPC is accepting or has accepted connections
Starting listening
inherit from BasicStatesDef
ErrHandlerTimeout indicates one of the state machine handlers has timed
out.
ErrNetwork indicates a generic network error.
Healthcheck is a periodic request making sure that the machine is still
alive.
Heartbeat is a periodic state that ensures the integrity of the machine.
Start indicates the machine should be working. Removing start can force
stop the machine.
SharedStatesDef.ErrDelivery string
SharedStatesDef.ErrNetworkTimeout string
SharedStatesDef.ErrRpc string
SharedStatesDef.Handshaking string
inherit from rpc/StateSourceStatesDef (for REPL)
ErrOnClient indicates an error added on the Network Machine.
StatesBase *am.StatesBase
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.
TCP tunneled over websocket
( ServerStatesDef) Names() machine.S
( ServerStatesDef) SetNames(names machine.S)
( ServerStatesDef) SetStateGroups(groups map[string][]int, order []string)
( ServerStatesDef) StateGroups() (map[string][]int, []string)
ServerStatesDef : github.com/pancsta/asyncmachine-go/pkg/machine.States
var ServerStates
StateSourceStatesDef contains all the states of the Network Source state
machine.
ErrOnClient indicates an error added on the Network Machine.
StatesBase *am.StatesBase
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) Names() machine.S
( StateSourceStatesDef) SetNames(names machine.S)
( StateSourceStatesDef) SetStateGroups(groups map[string][]int, order []string)
( StateSourceStatesDef) StateGroups() (map[string][]int, []string)
StateSourceStatesDef : github.com/pancsta/asyncmachine-go/pkg/machine.States
var StateSourceStates
Package-Level Variables (total 16)
ClientGroups contains all the state groups for the Client machine.
ClientSchema represents all relations and properties of ClientStates.
ClientStates contains all the states for the Client machine.
ConsumerSchema represents all relations and properties of ConsumerStates.
ConsumerStates contains all the states for the Consumer machine.
MuxGroups contains all the state groups for the Mux machine.
MuxSchema represents all relations and properties of MuxStatesDef.
MuxStates contains all the states for the Mux machine.
ServerGroups contains all the state groups for the Client machine.
ServerSchema represents all relations and properties of ClientStates.
ServerStates contains all the states for the Client machine.
StateSourceSchema represents all relations and properties of
[StateSourceStates].
StateSourceStates contains all the states for the Network Source 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. |