order

Documentation

Index

• Constants
• type MessageTo
• type Order
• type OrderChangePayload
• type OrderErrorPayload
• type OrderInformationPayload
• type OrderRenderPayload
• type OrderShutdownPayload
• type OrderStartUpPayload

Constants

const (
	// Basic orders from the main service to the modules
	OrderStartUp     = "OrderStartUp"
	OrderError       = "OrderError"
	OrderInformation = "OrderInformation"
	OrderChange      = "OrderChange"
	OrderShutdown    = "OrderShutdown"
	OrderRender      = "OrderRender"
)

Types

type MessageTo

type MessageTo struct {
	Notification string // ID to publish notification to ; should be itself
	Render       string // ID to publish render to ; should be one of the render wating routines
}

type Order

type Order struct {
	From    string // ID from who the message is. KiGo ID
	To      string // ID to who the message is. Module ID
	Order   string // what order to do, e.g. startup, update, render
	Payload any
}

type OrderChangePayload

type OrderChangePayload struct {
	Type    string
	Payload any
}

type OrderErrorPayload

type OrderErrorPayload struct {
	Message string // error message to report to the module, e.g. when a module is not responding or has an unexpected response
}

type OrderInformationPayload

type OrderInformationPayload struct {
	Payload any
}

type OrderRenderPayload

type OrderRenderPayload struct {
	ScreenWidth  int    // max screen width
	ScreenHeight int    // max screen height
	MaxFrameSize int    // max frame size
	ChannelName  string // channel name to use for transmission
	ObjectID     int    // objectID to use
}

type OrderShutdownPayload

type OrderShutdownPayload struct {
	Reason string // reason for shutdown, e.g. when the main service is shutting down, Publish to main
}

type OrderStartUpPayload

type OrderStartUpPayload struct {
	ID              string
	NumberOfModules int       // number of modules called startup ; incrementing number
	MessageTo       MessageTo // where to send the notifications and renders to
}