fsm

README

fsm

介绍

GO语言实现的FSM

软件架构

软件架构说明

安装教程

1. xxxx
2. xxxx
3. xxxx

使用说明

1. xxxx
2. xxxx
3. xxxx

参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request

特技

1. 使用 Readme_XXX.md 来支持不同的语言，例如 Readme_en.md, Readme_zh.md
2. Gitee 官方博客 blog.gitee.com
3. 你可以 https://gitee.com/explore 这个地址来了解 Gitee 上的优秀开源项目
4. GVP 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5. Gitee 官方提供的使用手册 https://gitee.com/help
6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 https://gitee.com/gitee-stars/

Documentation

Index

• type ArgsType
• type Callback
• type EventContext
• type EventType
• type Fsm
  • func NewFsm(fsmId string, initState StateType, stateTable map[StateType]*FsmState) *Fsm
  • func (sm *Fsm) SetLogFunc(logFunc LogFunc)
• type FsmEvent
• type FsmInst
  • func NewFsmInst(sm *Fsm, fsmInstId string) *FsmInst
  • func (fsmInst *FsmInst) CurrState() StateType
  • func (fsmInst *FsmInst) HandleEvent(evtCtxt *EventContext) error
  • func (inst FsmInst) MarshalJSON() ([]byte, error)
  • func (fsmInst *FsmInst) ResetState()
  • func (inst *FsmInst) UnmarshalJSON(data []byte) error
• type FsmState
• type LogFunc
• type ReturnVal
• type StateType

Types

type ArgsType

type ArgsType map[string]any

type Callback

type Callback func(state StateType, evtCtxt *EventContext) (newEvtCtxt *EventContext, rv ReturnVal)

newEvtCtxt将在下一个状态被处理

type EventContext

type EventContext struct {
	Event EventType
	Args  ArgsType
}

type EventType

type EventType string

type Fsm

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

func NewFsm

func NewFsm(fsmId string, initState StateType, stateTable map[StateType]*FsmState) *Fsm

func (*Fsm) SetLogFunc

func (sm *Fsm) SetLogFunc(logFunc LogFunc)

type FsmEvent

type FsmEvent struct {
	HandleFunc Callback
	TransTable map[ReturnVal]StateType
}

type FsmInst

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

func NewFsmInst

func NewFsmInst(sm *Fsm, fsmInstId string) *FsmInst

func (*FsmInst) CurrState

func (fsmInst *FsmInst) CurrState() StateType

func (*FsmInst) HandleEvent

func (fsmInst *FsmInst) HandleEvent(evtCtxt *EventContext) error

func (FsmInst) MarshalJSON

func (inst FsmInst) MarshalJSON() ([]byte, error)

MarshalJSON 自定义序列化方法

func (*FsmInst) ResetState

func (fsmInst *FsmInst) ResetState()

func (*FsmInst) UnmarshalJSON

func (inst *FsmInst) UnmarshalJSON(data []byte) error

UnmarshalJSON 自定义反序列化方法

type FsmState

type FsmState struct {
	DefaultHandle *FsmEvent
	EventTable    map[EventType]*FsmEvent
}

type LogFunc

type LogFunc func(format string, a ...any)

type ReturnVal

type ReturnVal int

type StateType

type StateType string