actions

Documentation

Index

• func NewActionsEvaluator(engine core.IEngine, store ostore.IObjectStore) *eval
• func ReadScenario(source string) (*spec.ScenarioDoc, error)
• type ActionHandler
• type Engine
  • func NewEngine(store ostore.IObjectStore) *Engine
  • func (e *Engine) ActiveScenarios() []string
  • func (e *Engine) GetInterface(ifaceId string) *spec.InterfaceEntry
  • func (e *Engine) GetPlayer(name string) *Player
  • func (e *Engine) GetProperties(symbol string) (map[string]any, error)
  • func (e *Engine) HasInterface(ifaceId string) bool
  • func (e *Engine) HasSequence(name string) bool
  • func (e *Engine) InvokeOperation(ifaceId string, opName string, args []any) (any, error)
  • func (e *Engine) LoadScenario(source string, doc *spec.ScenarioDoc) error
  • func (e *Engine) PlayAllSequences(ctx context.Context) error
  • func (e *Engine) PlaySequence(ctx context.Context, name string) error
  • func (e *Engine) ScenarioBySource(source string) *ScenarioEntry
  • func (e *Engine) SetProperties(symbol string, props map[string]any) error
  • func (e *Engine) StopAllSequences()
  • func (e *Engine) StopSequence(name string) error
  • func (a *Engine) UnloadScenario(source string) error
• type PlayFrame
• type Player
  • func NewPlayer(e *Engine, iface *spec.InterfaceEntry, seq *spec.SequenceEntry) *Player
  • func (p *Player) Play(ctx context.Context) error
  • func (p *Player) SequenceName() string
  • func (p *Player) Stop() error
• type ScenarioEntry

Functions

func NewActionsEvaluator

func NewActionsEvaluator(engine core.IEngine, store ostore.IObjectStore) *eval

func ReadScenario

func ReadScenario(source string) (*spec.ScenarioDoc, error)

ReadScenario reads a scenario from file.

Types

type ActionHandler

type ActionHandler func(symbol string, args map[string]any) (any, error)

type Engine

type Engine struct {
	core.EventNotifier
	// contains filtered or unexported fields
}

func NewEngine

func NewEngine(store ostore.IObjectStore) *Engine

func (*Engine) ActiveScenarios

func (e *Engine) ActiveScenarios() []string

func (*Engine) GetInterface

func (e *Engine) GetInterface(ifaceId string) *spec.InterfaceEntry

func (*Engine) GetPlayer

func (e *Engine) GetPlayer(name string) *Player

GetPlayer returns the player with the given name

func (*Engine) GetProperties

func (e *Engine) GetProperties(symbol string) (map[string]any, error)

FetchProperties returns a copy of the properties of the interface.

func (*Engine) HasInterface

func (e *Engine) HasInterface(ifaceId string) bool

func (*Engine) HasSequence

func (e *Engine) HasSequence(name string) bool

func (*Engine) InvokeOperation

func (e *Engine) InvokeOperation(ifaceId string, opName string, args []any) (any, error)

InvokeOperation invokes a operation of the interface.

func (*Engine) LoadScenario

func (e *Engine) LoadScenario(source string, doc *spec.ScenarioDoc) error

func (*Engine) PlayAllSequences

func (e *Engine) PlayAllSequences(ctx context.Context) error

func (*Engine) PlaySequence

func (e *Engine) PlaySequence(ctx context.Context, name string) error

func (*Engine) ScenarioBySource

func (e *Engine) ScenarioBySource(source string) *ScenarioEntry

ScenarioBySource returns the scenario with the given source

func (*Engine) SetProperties

func (e *Engine) SetProperties(symbol string, props map[string]any) error

SetProperties updates the properties of the interface.

func (*Engine) StopAllSequences

func (e *Engine) StopAllSequences()

func (*Engine) StopSequence

func (e *Engine) StopSequence(name string) error

func (*Engine) UnloadScenario

func (a *Engine) UnloadScenario(source string) error

type PlayFrame

type PlayFrame struct {
	Action    spec.ActionEntry
	Interface *spec.InterfaceEntry
}

type Player

type Player struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Player is a player for one sequence It plays the sequence and sends the actions to the stream The stream is closed when the sequence is finished Actions are evaluated in the context of an interface

func NewPlayer

func NewPlayer(e *Engine, iface *spec.InterfaceEntry, seq *spec.SequenceEntry) *Player

NewPlayer creates a new sequence player

func (*Player) Play

func (p *Player) Play(ctx context.Context) error

Play starts the sequence It runs the sequence in a goroutine

func (*Player) SequenceName

func (p *Player) SequenceName() string

SequenceName returns the name of the sequence

func (*Player) Stop

func (p *Player) Stop() error

Stop stops the play loop

type ScenarioEntry

type ScenarioEntry struct {
	Source  string
	Doc     *spec.ScenarioDoc
	Players []*Player
}