external

Documentation

Overview

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

Index

• Constants
• type ManagementService
  • func NewManagementService(RuntimePath string) (ManagementService, error)
• type NotifyService
  • func NewNotifyService(runtimePath string) NotifyService
• type ShareService
  • func NewShareService(runtimePath string) ShareService

Constants

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

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

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

Types

type ManagementService

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

func NewManagementService

func NewManagementService(RuntimePath string) (ManagementService, error)

type NotifyService

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

func NewNotifyService

func NewNotifyService(runtimePath string) NotifyService

type ShareService

type ShareService interface {
	DeleteShare(id string) error
}

func NewShareService

func NewShareService(runtimePath string) ShareService