notification

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 1, 2026 License: MIT Imports: 1 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// Basic notifications from the modules to the main service
	NotificationReady  = "NotificationReady"  // called when the module is ready to receive orders, i.e. after startup procedore, Publish to main
	NotificationUpdate = "NotificationUpdate" // called when the module has an update, i.e. update data or state, Publisch to main
	NotificationRender = "NotificationRender" // called when the module needs to render something, i.e. after update or order, Publish to main
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Notification

type Notification struct {
	From         string
	To           string
	Notification string
	Payload      any
}

type NotificationReadyPayload

type NotificationReadyPayload struct {
	Duration        time.Duration // Duration needed to be ready, when should order startup be called
	CallingInterval time.Duration // Interval in which the module should be updated without beeing called directly  TODO: needed ?
}

type NotificationRenderPayload

type NotificationRenderPayload struct {
	// where to render
	PositionX int
	PositionY int

	Object []byte // object to render
	Path   string // path to the object to render, if object is empty, path should be used
}

type NotificationUpdatePayload

type NotificationUpdatePayload struct {
	Duration time.Duration // Duration needed to update, when should notification render be called
}

Jump to

Keyboard shortcuts

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