finitestate

Documentation

Index

• Constants
• Variables
• type Machine
  • func New(handler slog.Handler) (*Machine, error)
  • func (s *Machine) GetStateChanWithTimeout(ctx context.Context) <-chan string

Constants

const (
	StatusNew       = fsm.StatusNew
	StatusBooting   = fsm.StatusBooting
	StatusRunning   = fsm.StatusRunning
	StatusReloading = fsm.StatusReloading
	StatusStopping  = fsm.StatusStopping
	StatusStopped   = fsm.StatusStopped
	StatusError     = fsm.StatusError
	StatusUnknown   = fsm.StatusUnknown
)

Variables

var TypicalTransitions = fsm.TypicalTransitions

TypicalTransitions is a set of standard transitions for a finite state machine.

Types

type Machine

type Machine struct {
	*fsm.Machine
}

Machine is a wrapper around go-fsm.Machine that provides additional functionality.

func New

func New(handler slog.Handler) (*Machine, error)

New creates a new finite state machine with the specified logger using "standard" state transitions.

func (*Machine) GetStateChanWithTimeout

func (s *Machine) GetStateChanWithTimeout(ctx context.Context) <-chan string

GetStateChan returns a channel that emits the state whenever it changes. The channel is closed when the provided context is canceled.