modmanager

Documentation

Overview

Package modmanager provides the module manager for a robot.

Index

• func DepsToNames(deps resource.Dependencies) []string
• func NewManager(parentAddr string, logger golog.Logger, options modmanageroptions.Options) modmaninterface.ModuleManager
• type Manager
  • func (mgr *Manager) Add(ctx context.Context, conf config.Module) error
  • func (mgr *Manager) AddResource(ctx context.Context, conf resource.Config, deps []string) (resource.Resource, error)
  • func (mgr *Manager) Close(ctx context.Context) error
  • func (mgr *Manager) Configs() []config.Module
  • func (mgr *Manager) IsModularResource(name resource.Name) bool
  • func (mgr *Manager) Provides(conf resource.Config) bool
  • func (mgr *Manager) Reconfigure(ctx context.Context, conf config.Module) ([]resource.Name, error)
  • func (mgr *Manager) ReconfigureResource(ctx context.Context, conf resource.Config, deps []string) error
  • func (mgr *Manager) Remove(modName string) ([]resource.Name, error)
  • func (mgr *Manager) RemoveResource(ctx context.Context, name resource.Name) error
  • func (mgr *Manager) ValidateConfig(ctx context.Context, conf resource.Config) ([]string, error)

Functions

func DepsToNames

func DepsToNames(deps resource.Dependencies) []string

DepsToNames converts a dependency list to a simple string slice.

func NewManager

func NewManager(parentAddr string, logger golog.Logger, options modmanageroptions.Options) modmaninterface.ModuleManager

NewManager returns a Manager.

Types

type Manager

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

Manager is the root structure for the module system.

func (*Manager) Add

func (mgr *Manager) Add(ctx context.Context, conf config.Module) error

Add adds and starts a new resource module.

func (*Manager) AddResource

func (mgr *Manager) AddResource(ctx context.Context, conf resource.Config, deps []string) (resource.Resource, error)

AddResource tells a component module to configure a new component.

func (*Manager) Close

func (mgr *Manager) Close(ctx context.Context) error

Close terminates module connections and processes.

func (*Manager) Configs

func (mgr *Manager) Configs() []config.Module

Configs returns a slice of config.Module representing the currently managed modules.

func (*Manager) IsModularResource

func (mgr *Manager) IsModularResource(name resource.Name) bool

IsModularResource returns true if an existing resource IS handled by a module.

func (*Manager) Provides

func (mgr *Manager) Provides(conf resource.Config) bool

Provides returns true if a component/service config WOULD be handled by a module.

func (*Manager) Reconfigure

func (mgr *Manager) Reconfigure(ctx context.Context, conf config.Module) ([]resource.Name, error)

Reconfigure reconfigures an existing resource module and returns the names of now orphaned resources.

func (*Manager) ReconfigureResource

func (mgr *Manager) ReconfigureResource(ctx context.Context, conf resource.Config, deps []string) error

ReconfigureResource updates/reconfigures a modular component with a new configuration.

func (*Manager) Remove

func (mgr *Manager) Remove(modName string) ([]resource.Name, error)

Remove removes and stops an existing resource module and returns the names of now orphaned resources.

func (*Manager) RemoveResource

func (mgr *Manager) RemoveResource(ctx context.Context, name resource.Name) error

RemoveResource requests the removal of a resource from a module.

func (*Manager) ValidateConfig

func (mgr *Manager) ValidateConfig(ctx context.Context, conf resource.Config) ([]string, error)

ValidateConfig determines whether the given config is valid and returns its implicit dependencies.