retort v1.3.0 Retort.Client.StateMachine
Manipulates the remote state machines over RPC
Summary
Types
Data
State in data
struct
current_goal
- the currentstate
we wantdata
to have.data
- thedata
forpid
that has astate
field.pid
- the RPC client pid, used to update the state ofdata
towards thecurrent_goal
predecessor_by_state
- thestate
that can transition to keystate
previous_goals
- a list of the previouscurrent_goal
s that couldn’t be transitioned to directly because the predecessor inprecessor_by_state
was notdata
’sstate
.update
- callback that takest
and updates the state tocurrent_goal
Functions
Transitions data
’s state
to current_goal
. If data
’s state
is a not direct predecessor of current_goal
,
then a path is found to get data
’s state
to current_goal
using predecessor_by_state
Types
Data
State in data
struct.
current_goal
- the currentstate
we wantdata
to have.data
- thedata
forpid
that has astate
field.pid
- the RPC client pid, used to update the state ofdata
towards thecurrent_goal
predecessor_by_state
- thestate
that can transition to keystate
previous_goals
- a list of the previouscurrent_goal
s that couldn’t be transitioned to directly because the predecessor inprecessor_by_state
was notdata
’sstate
.update
- callback that takest
and updates the state tocurrent_goal
.
Functions
Transitions data
’s state
to current_goal
. If data
’s state
is a not direct predecessor of current_goal
,
then a path is found to get data
’s state
to current_goal
using predecessor_by_state
.