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)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
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) 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) Configs ¶ added in v0.2.50
Configs returns a slice of config.Module representing the currently managed modules.
func (*Manager) IsModularResource ¶
IsModularResource returns true if an existing resource IS handled by a module.
func (*Manager) Provides ¶
Provides returns true if a component/service config WOULD be handled by a module.
func (*Manager) Reconfigure ¶ added in v0.2.34
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 ¶ added in v0.2.34
Remove removes and stops an existing resource module and returns the names of now orphaned resources.
func (*Manager) RemoveResource ¶
RemoveResource requests the removal of a resource from a module.