module

README

Tinysystems module

Collection of structs and interfaces to be used by module implementations

Documentation

Index

• Constants
• func GetNodeFullName(prefix string, module string, component string) string
• func ParseFullName(fullName string) (module string, component string, err error)
• type AddressUpgrade
• type Component
• type ComponentInfo
  • func (c ComponentInfo) GetResourceName() string
• type HTTPService
• type Handler
• type Info
  • func (i Info) GetMajorName() string
  • func (i Info) GetMajorNameSanitised() string
  • func (i Info) GetNameAndVersion() string
• type ListenAddressGetter
• type NodePort
• type Position
• type StatefulComponent

Constants

const (
	SaveStatePort string = "_save-state"
	GetStatePort         = "_get-state"
	SettingsPort         = "_settings"
	RefreshPort          = "_refresh"
)

Functions

func GetNodeFullName

func GetNodeFullName(prefix string, module string, component string) string

func ParseFullName

func ParseFullName(fullName string) (module string, component string, err error)

Types

type AddressUpgrade

type AddressUpgrade func(ctx context.Context, auto bool, hostnames []string, actualLocalPort int) ([]string, error)

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
}

func (ComponentInfo) GetResourceName

func (c ComponentInfo) GetResourceName() string

type HTTPService

type HTTPService interface {
	HTTPService(getter ListenAddressGetter)
}

type Handler

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

type Info

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

func (Info) GetMajorName

func (i Info) GetMajorName() string

func (Info) GetMajorNameSanitised

func (i Info) GetMajorNameSanitised() string

func (Info) GetNameAndVersion

func (i Info) GetNameAndVersion() string

GetNameAndVersion Container image full name

type ListenAddressGetter

type ListenAddressGetter func() (suggestedPort int, upgrade AddressUpgrade)

ListenAddressGetter gets listen port address

type NodePort

type NodePort struct {
	// if that's a source port, source means it accepts the data, the source of incoming data
	Source bool
	// this port's DTO will be shown as a control panel
	Control bool
	// port with Settings equals true will be shown in configuration tab
	Settings bool
	// which side of the node will have this port
	Position Position
	// Name lower case programmatic name
	Name string
	// Human readable name (capital cased)
	Label string
	// DTO object
	Configuration interface{}
}

type Position

type Position int

const (
	Top Position = iota
	Right
	Bottom
	Left
)

type StatefulComponent

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

StatefulComponent WIP