module

README

DTO

Documentation

Index

• Constants
• func GetComponentID(moduleInfo Info, cmpInfo ComponentInfo) (string, error)
• type Component
• type ComponentInfo
• type Handler
• type Info
• type NodePort
  • func GetPortByName(ports []NodePort, name string) *NodePort
• type Position
• type Runnable
• type StatefulComponent

Constants

const (
	InformerNodeID         = "_informer"
	PlatformSubjectPattern = "platform.*"
	GetManifestSubject     = "get_manifest"
	PublishModuleSubject   = "publish_manifest"
	UpdateModuleSubject    = "update_manifest"
)

const (
	SaveStatePort string = "_save-state"
	GetStatePort  string = "_get-state"
	ConfigurePort string = "_configure"
	RunPort       string = "_run"
	StopPort      string = "_stop"
	DestroyPort   string = "_destroy"
	SettingsPort  string = "_settings"
	StatusPort    string = "_status"
)

Functions

func GetComponentID

func GetComponentID(moduleInfo Info, cmpInfo ComponentInfo) (string, error)

Types

type Component

type Component interface {
	GetInfo() ComponentInfo
	//Handle handles incoming requests
	Handle(ctx context.Context, output Handler, port string, message interface{}) error
	//Ports gets list of ports
	Ports() []NodePort
	//Instance creates new instance with default settings
	Instance() Component
}

type ComponentInfo

type ComponentInfo struct {
	Name        string
	Description string
	Info        string
	Tags        []string
}

type Handler

type Handler func(port string, data interface{}) error

type Info

type Info struct {
	VersionID string // if module's build is registered
	Version   string
	Name      string
}

type NodePort

type NodePort struct {
	Source   bool
	Status   bool
	Settings bool
	Position Position
	Name     string
	Label    string
	Message  interface{}
}

func GetPortByName

func GetPortByName(ports []NodePort, name string) *NodePort

type Position

type Position int

const (
	Top Position = iota
	Right
	Bottom
	Left
)

type Runnable

type Runnable interface {
	Run(ctx context.Context, handler Handler) error
}

type StatefulComponent

type StatefulComponent interface {
	GetState() ([]byte, error)
	SetState(state []byte) error
}

StatefulComponent WIP