fsm

README

fsm

Finite-state machine in go

Introduction

• 点击进入中文相关说明
• Click to article in English

Installation

go get -u github.com/iTrellis/fsm

Usage

fsm repo

// FSMRepo the functions of fsm interface
type FSMRepo interface {
	// add a transction into cache
	Add(*Transaction)
	// remove all transactions
	Remove()
	// remove namespace's transactions
	RemoveNamespace(namespace string)
	// remove a transaction by information
	RemoveByTransaction(*Transaction)
	// get target transaction by current information
	GetTargetTranstion(namespace, curStatus, event string) *Transaction
}

new and input a namespace's transaction

	f := fsm.New()

	f.Add(&fsm.Transaction{
			Namespace:     "namespace",
			CurrentStatus: "status1",
			Event:         "event1",
			TargetStatus:  "status2",
		})
	fmt.Println(f.GetTargetTranstion("namespace", "status1", "event1"))

	f.Remove()

	fmt.Println(f.GetTargetTranstion("namespace", "status1", "event1"))

Config

• sample.yaml

Documentation

Index

• Variables
• func NewTransactionFromConfig(filepath string) error
• func NewTransactions(cfg config.Config) (err error)
• type Repo
  • func New() Repo
• type Transaction

Variables

var (
	ErrInvalidTransaction = errors.New("invalid transaction")
	ErrTargetStatusEmpty  = errors.New("empty target status")
)

errors

Functions

func NewTransactionFromConfig

func NewTransactionFromConfig(filepath string) error

NewTransactionFromConfig new transactions from config file

func NewTransactions

func NewTransactions(cfg config.Config) (err error)

NewTransactions new transactions

Types

type Repo

type Repo interface {
	// add a transction into cache
	Add(*Transaction)
	// remove all transactions
	Remove()
	// remove namespace's transactions
	RemoveNamespace(namespace string)
	// remove a transaction by information
	RemoveByTransaction(*Transaction)
	// get target transaction by current information
	GetTargetTranstion(namespace, curStatus, event string) *Transaction
}

Repo the functions of fsm interface

func New

func New() Repo

New get default fsm

type Transaction

type Transaction struct {
	Namespace     string `json:"namespace"`
	CurrentStatus string `json:"current"`
	Event         string `json:"event"`
	TargetStatus  string `json:"target"`
}

Transaction information for current to target status in namespace