core

Documentation

Index

• Constants
• type Config
  • func (c *Config) IsActive() bool
• type Module
  • func NewModule() *Module
  • func (m *Module) BackendOperator() backend.Operator
  • func (m *Module) Config() module.ConfigInterface
  • func (m *Module) InstanceID() string
  • func (m *Module) Name() string
  • func (m *Module) NotifyStartSuccess()
  • func (m *Module) RequiredModules() []string
  • func (m *Module) Shutdown(ctx context.Context, mgr *module.Manager) error
  • func (m *Module) Start(ctx context.Context, mgr *module.Manager) error
• type Operator

Constants

const ModuleName = "core"

Types

type Config

type Config struct {
	// module common config
	module.Config `mapstructure:",squash"`

	// backend connection
	BackendConfig *backend.Config `mapstructure:"backend"`
}

func (*Config) IsActive

func (c *Config) IsActive() bool

type Module

type Module struct {
	// contains filtered or unexported fields
}

func NewModule

func NewModule() *Module

func (*Module) BackendOperator

func (m *Module) BackendOperator() backend.Operator

func (*Module) Config

func (m *Module) Config() module.ConfigInterface

func (*Module) InstanceID

func (m *Module) InstanceID() string

func (*Module) Name

func (m *Module) Name() string

func (*Module) NotifyStartSuccess

func (m *Module) NotifyStartSuccess()

func (*Module) RequiredModules

func (m *Module) RequiredModules() []string

func (*Module) Shutdown

func (m *Module) Shutdown(ctx context.Context, mgr *module.Manager) error

func (*Module) Start

func (m *Module) Start(ctx context.Context, mgr *module.Manager) error

type Operator

type Operator interface {
	// InstanceId of Rover
	InstanceID() string
	// BackendOperator for operate with backend client
	BackendOperator() backend.Operator
}

Operator when the other module operate with core module