mon

package

v0.37.0 Latest Latest Go to latest Published: Feb 26, 2024 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/apigear-io/cli

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Must(err error)
type Event
- func ReadCsvEvents(fn string) ([]Event, error)
- func ReadJsonEvents(fn string) ([]Event, error)
type EventFactory
- func NewEventFactory(source string) *EventFactory
type EventScript
- func NewEventScript() *EventScript
- func (s *EventScript) RunScript(script string) ([]Event, error)
- func (s *EventScript) RunScriptFromFile(file string) ([]Event, error)
type EventType
- func ParseEventType(s string) EventType
- func (e EventType) String() string
type Payload

Constants ¶

This section is empty.

Variables ¶

View Source

var Emitter = helper.NewEventEmitter[*Event]()

Functions ¶

func Must ¶

func Must(err error)

Types ¶

type Event ¶

type Event struct {
	Id        string    `json:"id" yaml:"id" csv:"id"`
	Source    string    `json:"source" yaml:"source" csv:"source"`
	Type      EventType `json:"type" yaml:"type" csv:"type"`
	Timestamp time.Time `json:"timestamp" yaml:"timestamp" csv:"timestamp"`
	Symbol    string    `json:"symbol" yaml:"symbol" csv:"symbol"`
	Data      Payload   `json:"data" yaml:"data" csv:"data"`
}

Event represents an API event.

func ReadCsvEvents ¶

func ReadCsvEvents(fn string) ([]Event, error)

ReadCsvEvents reads events from a csv file and sends them to the emitter channel.

func ReadJsonEvents ¶

func ReadJsonEvents(fn string) ([]Event, error)

ReadJsonEvents reads monitor events from a json stream file

type EventFactory ¶

type EventFactory struct {
	Source string
}

EventFactory is used to create events. Factory associates device ids and sources with events.

func NewEventFactory ¶

func NewEventFactory(source string) *EventFactory

NewEventFactory creates a new event factory.

func (EventFactory) MakeCall ¶

func (f EventFactory) MakeCall(symbol string, data Payload) *Event

MakeCall creates a call event with the given symbol and params.

func (EventFactory) MakeEvent ¶

func (f EventFactory) MakeEvent(kind EventType, symbol string, data Payload) *Event

MakeEvent creates an event with the given kind, symbol and params.

func (EventFactory) MakeSignal ¶

func (f EventFactory) MakeSignal(symbol string, data Payload) *Event

MakeSignal creates a signal event with the given symbol and params.

func (EventFactory) MakeState ¶

func (f EventFactory) MakeState(symbol string, data Payload) *Event

MakeState creates a state event with the given symbol and props.

func (EventFactory) Sanitize ¶

func (f EventFactory) Sanitize(event *Event) *Event

Sanitize ensures events are valid and fills in missing fields.

type EventScript ¶

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

func NewEventScript ¶

func NewEventScript() *EventScript

func (*EventScript) RunScript ¶

func (s *EventScript) RunScript(script string) ([]Event, error)

func (*EventScript) RunScriptFromFile ¶

func (s *EventScript) RunScriptFromFile(file string) ([]Event, error)

type EventType ¶

type EventType string

EventType is the type of event.

const (
	TypeCall   EventType = "call"
	TypeSignal EventType = "signal"
	TypeState  EventType = "state"
)

func ParseEventType ¶

func ParseEventType(s string) EventType

func (EventType) String ¶

func (e EventType) String() string

type Payload ¶

type Payload map[string]any

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL