fsm

Documentation

Index

• Variables
• type Action
• type Event
• type Events
• type Hook
• type State
• type StateMachine
  • func New(state State, stateTransitions StateTransitions, hook Hook) *StateMachine
  • func (s *StateMachine) Current() State
  • func (s *StateMachine) Transition(ctx context.Context) error
• type StateTransitions
• type Transition

Variables

var ErrEventRejected = errors.New("event rejected")

ErrEventRejected is the error returned when the state machine cannot process an event in the state that it is in.

Types

type Action

type Action func(ctx context.Context) (Event, error)

Action represents the action to be executed in a given state.

type Event

type Event string

Event represents an extensible event type in the state machine.

const (
	// NoOp represents a no-op event. State machine stops when this event is emitted.
	NoOp Event = "NoOp"
)

type Events

type Events map[Event]State

Events represents a mapping of events and states.

type Hook

type Hook func(ctx context.Context, currentState, nextState State, event Event) error

Hook is called on each state machine transition.

type State

type State string

State represents an extensible state type in the state machine.

type StateMachine

type StateMachine struct {
	// contains filtered or unexported fields
}

StateMachine represents the state machine.

func New

func New(state State, stateTransitions StateTransitions, hook Hook) *StateMachine

New returns initialized state machine.

func (*StateMachine) Current

func (s *StateMachine) Current() State

Current return current state machine state.

func (*StateMachine) Transition

func (s *StateMachine) Transition(ctx context.Context) error

Transition triggers current state action and sends event to the state machine.

type StateTransitions

type StateTransitions map[State]Transition

StateTransitions represents a mapping of states and their implementations.

type Transition

type Transition struct {
	Action Action
	Events Events
}

Transition binds a state with an action and a set of events it can handle.