Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v0

v0.14.0

May 8, 2025

Changes in this version

+ const ConfigurationVersionSeparator

+ var EmptyStartingStateConfigurationError = fmt.Errorf("the StartingState must be non-empty")

+ var Logger = log.NewLog("api")

+ var MalformedConfigurationError = fmt.Errorf("this configuration cannot be parsed")

+ var MismatchStartingStateConfigurationError = fmt.Errorf("the StartingState must be one of the possible FSM states")

+ var MissingDestinationError = fmt.Errorf("event must always have a `Destination` statemachine")

+ var MissingEventNameError = fmt.Errorf("events must always specify the event type")

+ var MissingNameConfigurationError = fmt.Errorf("configuration must always specify a name (and optionally a version)")

+ var MissingStatesConfigurationError = fmt.Errorf("configuration must always specify at least one state")

+ var Release string

+ var UnexpectedError = fmt.Errorf("the request was malformed")

+ var UnexpectedTransitionError = fmt.Errorf("unexpected event transition")

+ var UnreachableStateConfigurationError = "state %s is not used in any of the transitions"

+ func CfgHasState(configuration *protos.Configuration, state string) bool

+ func CheckValid(c *protos.Configuration) error

+ func GetVersionId(c *protos.Configuration) string

+ func HasState(transition *protos.Transition, state string) bool

+ func NewEvent(eventName string) *protos.Event

+ func UpdateEvent(event *protos.Event)

+ type ConfiguredStateMachine struct

+ Config *protos.Configuration

+ FSM *protos.FiniteStateMachine

+ func NewStateMachine(configuration *protos.Configuration) (*ConfiguredStateMachine, error)

+ func (x *ConfiguredStateMachine) CheckValid() bool

+ func (x *ConfiguredStateMachine) Reset()

+ func (x *ConfiguredStateMachine) SendEvent(evt *protos.Event) error

v0.13.2-gc72711f

Mar 17, 2024

v0.13.0-g6e9e42d

Mar 16, 2024