external

Documentation

Overview

The commmon package provides structs and functions for external code to interact with this gateway service.

Index

• Constants
• func GetMessageBusAddress(runtimePath string) (string, error)
• func GetPublicKey(runtimePath string) (*ecdsa.PublicKey, error)
• func PrintEventTypesAsMarkdown(sourceID, version string, eventTypes []EventType)
• type EventType
• type GPUInfo
  • func GPUInfoList() ([]GPUInfo, error)
• type ManagementService
  • func NewManagementService(RuntimePath string) (ManagementService, error)
• type NotifyService
  • func NewNotifyService(runtimePath string) NotifyService
• type PropertyType
• type ShareService
  • func NewShareService(runtimePath string) ShareService

Constants

const (
	ManagementURLFilename = "management.url"
	StaticURLFilename     = "static.url"
	APIGatewayRoutes      = "/v1/gateway/routes"
	APIGatewayPort        = "/v1/gateway/port"
)

const (
	MessageBusAddressFilename = "message-bus.url"
	APIMessageBus             = "/v2/message_bus"
)

const (
	CasaOSURLFilename = "casaos.url"
	APICasaOSNotify   = "/v1/notify"
)

const (
	APICasaOSShare = "/v1/samba/shares"
)

const (
	UserServiceAddressFilename = "user-service.url"
)

Functions

func GetMessageBusAddress

func GetMessageBusAddress(runtimePath string) (string, error)

func GetPublicKey

func GetPublicKey(runtimePath string) (*ecdsa.PublicKey, error)

func PrintEventTypesAsMarkdown

func PrintEventTypesAsMarkdown(sourceID, version string, eventTypes []EventType)

Types

type EventType

type EventType struct {
	Name             string
	SourceID         string
	PropertyTypeList []PropertyType
}

type GPUInfo

type GPUInfo struct {
	Index          int
	UUID           string
	UtilizationGPU int
	MemoryTotal    int
	MemoryUsed     int
	MemoryFree     int
	DriverVersion  string
	Name           string
	GPUSerial      string
	DisplayActive  bool
	DisplayMode    bool
	TemperatureGPU int
}

func GPUInfoList

func GPUInfoList() ([]GPUInfo, error)

type ManagementService

type ManagementService interface {
	CreateRoute(route *model.Route) error
	ChangePort(request *model.ChangePortRequest) error
	GetPort() (error, string)
}

func NewManagementService

func NewManagementService(RuntimePath string) (ManagementService, error)

type NotifyService

type NotifyService interface {
	SendNotify(path string, message interface{}) error
	SendSystemStatusNotify(message map[string]interface{}) error
}

func NewNotifyService

func NewNotifyService(runtimePath string) NotifyService

type PropertyType

type PropertyType struct {
	Name        string
	Description *string
	Example     *string
}

type ShareService

type ShareService interface {
	DeleteShare(id string) error
}

func NewShareService

func NewShareService(runtimePath string) ShareService