plugin_loader_filesystem

Documentation

Index

• Constants
• Variables
• type Config
  • func (m *Config) CloneGenericVT() proto.Message
  • func (m *Config) CloneVT() *Config
  • func (*Config) Descriptor() ([]byte, []int)
  • func (this *Config) EqualVT(that *Config) bool
  • func (c *Config) EqualsConfig(c2 config.Config) bool
  • func (c *Config) GetConfigID() string
  • func (x *Config) GetDir() string
  • func (x *Config) GetWatch() bool
  • func (m *Config) MarshalToSizedBufferVT(dAtA []byte) (int, error)
  • func (m *Config) MarshalToVT(dAtA []byte) (int, error)
  • func (m *Config) MarshalVT() (dAtA []byte, err error)
  • func (*Config) ProtoMessage()
  • func (x *Config) ProtoReflect() protoreflect.Message
  • func (x *Config) Reset()
  • func (m *Config) SizeVT() (n int)
  • func (x *Config) String() string
  • func (m *Config) UnmarshalVT(dAtA []byte) error
  • func (c *Config) Validate() error
• type Controller
  • func NewController(le *logrus.Entry, bus bus.Bus, conf *Config) (*Controller, error)
  • func (c *Controller) Close() error
  • func (c *Controller) Execute(ctx context.Context) error
  • func (c *Controller) GetControllerInfo() *controller.Info
  • func (c *Controller) HandleDirective(ctx context.Context, di directive.Instance) (directive.Resolver, error)
• type Factory
  • func NewFactory(bus bus.Bus) *Factory
  • func (t *Factory) Construct(conf config.Config, opts controller.ConstructOpts) (controller.Controller, error)
  • func (t *Factory) ConstructConfig() config.Config
  • func (t *Factory) GetConfigID() string
  • func (t *Factory) GetControllerID() string
  • func (t *Factory) GetVersion() semver.Version
• type Watcher
  • func NewWatcher(le *logrus.Entry, bus bus.Bus) *Watcher
  • func (w *Watcher) Execute(ctx context.Context, syncDir string, watch bool) error
  • func (w *Watcher) LoadPlugin(ctx context.Context, plugPath string) error
  • func (w *Watcher) SyncPlugins(ctx context.Context, scanDir string) error
  • func (w *Watcher) UnloadAll()
  • func (w *Watcher) UnloadPlugin(id string)

Constants

const ConfigID = ControllerID

ConfigID is the identifier for the config type.

const ControllerID = "controllerbus/plugin/loader/shared-library/filesystem/1"

ControllerID is the ID of the controller.

Variables

var (
	ErrInvalidLength        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflow          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroup = fmt.Errorf("proto: unexpected end of group")
)

var File_github_com_aperturerobotics_controllerbus_plugin_loader_shared_library_filesystem_config_proto protoreflect.FileDescriptor

var Version = semver.MustParse("0.0.1")

Version is the version of the controller implementation.

Types

type Config

type Config struct {

	// Dir is the directory to load from.
	Dir string `protobuf:"bytes,1,opt,name=dir,proto3" json:"dir,omitempty"`
	// Watch will watch the directory and hot-reload plugins.
	Watch bool `protobuf:"varint,2,opt,name=watch,proto3" json:"watch,omitempty"`
	// contains filtered or unexported fields
}

Config is configuration for the filesystem hot-plugin loader.

func (*Config) CloneGenericVT

func (m *Config) CloneGenericVT() proto.Message

func (*Config) CloneVT

func (m *Config) CloneVT() *Config

func (*Config) Descriptor

func (*Config) Descriptor() ([]byte, []int)

Deprecated: Use Config.ProtoReflect.Descriptor instead.

func (*Config) EqualVT

func (this *Config) EqualVT(that *Config) bool

func (*Config) EqualsConfig

func (c *Config) EqualsConfig(c2 config.Config) bool

EqualsConfig checks equality between two configs.

func (*Config) GetConfigID

func (c *Config) GetConfigID() string

GetConfigID returns the config identifier.

func (*Config) GetDir

func (x *Config) GetDir() string

func (*Config) GetWatch

func (x *Config) GetWatch() bool

func (*Config) MarshalToSizedBufferVT

func (m *Config) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Config) MarshalToVT

func (m *Config) MarshalToVT(dAtA []byte) (int, error)

func (*Config) MarshalVT

func (m *Config) MarshalVT() (dAtA []byte, err error)

func (*Config) ProtoMessage

func (*Config) ProtoMessage()

func (*Config) ProtoReflect

func (x *Config) ProtoReflect() protoreflect.Message

func (*Config) Reset

func (x *Config) Reset()

func (*Config) SizeVT

func (m *Config) SizeVT() (n int)

func (*Config) String

func (x *Config) String() string

func (*Config) UnmarshalVT

func (m *Config) UnmarshalVT(dAtA []byte) error

func (*Config) Validate

func (c *Config) Validate() error

Validate validates the configuration.

type Controller

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

Controller is the hot plugin filesystem loading controller.

NOTE: Go plugins cannot be unloaded (Go 1.16). This is only a prototype.

func NewController

func NewController(le *logrus.Entry, bus bus.Bus, conf *Config) (*Controller, error)

NewController constructs a new controller.

func (*Controller) Close

func (c *Controller) Close() error

Close releases any resources used by the controller. Error indicates any issue encountered releasing.

func (*Controller) Execute

func (c *Controller) Execute(ctx context.Context) error

Execute executes the given controller. Returning nil ends execution. Returning an error triggers a retry with backoff.

func (*Controller) GetControllerInfo

func (c *Controller) GetControllerInfo() *controller.Info

GetControllerInfo returns information about the controller.

func (*Controller) HandleDirective

func (c *Controller) HandleDirective(
	ctx context.Context,
	di directive.Instance,
) (directive.Resolver, error)

HandleDirective asks if the handler can resolve the directive. If it can, it returns a resolver. If not, returns nil. Any exceptional errors are returned for logging. It is safe to add a reference to the directive during this call.

type Factory

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

Factory constructs a hot loading from filesystem controller.

func NewFactory

func NewFactory(bus bus.Bus) *Factory

NewFactory builds a websocket transport factory.

func (*Factory) Construct

func (t *Factory) Construct(
	conf config.Config,
	opts controller.ConstructOpts,
) (controller.Controller, error)

Construct constructs the associated controller given configuration.

func (*Factory) ConstructConfig

func (t *Factory) ConstructConfig() config.Config

ConstructConfig constructs an instance of the controller configuration.

func (*Factory) GetConfigID

func (t *Factory) GetConfigID() string

GetConfigID returns the configuration ID for the controller.

func (*Factory) GetControllerID

func (t *Factory) GetControllerID() string

GetControllerID returns the unique ID for the controller.

func (*Factory) GetVersion

func (t *Factory) GetVersion() semver.Version

GetVersion returns the version of this controller.

type Watcher

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

Watcher watches a filesystem path to load and reload plugins.

func NewWatcher

func NewWatcher(le *logrus.Entry, bus bus.Bus) *Watcher

NewWatcher builds a new filesystem watcher.

func (*Watcher) Execute

func (w *Watcher) Execute(ctx context.Context, syncDir string, watch bool) error

Execute executes the watcher and loads / runs plugins.

func (*Watcher) LoadPlugin

func (w *Watcher) LoadPlugin(ctx context.Context, plugPath string) error

LoadPlugin loads a plugin from a path.

If the path was already loaded, no-op.

func (*Watcher) SyncPlugins

func (w *Watcher) SyncPlugins(ctx context.Context, scanDir string) error

SyncPlugins synchronizes the loaded plugins with all in a scan dir.

If any plugin files were removed, unloads those plugins.

func (*Watcher) UnloadAll

func (w *Watcher) UnloadAll()

UnloadAll unloads all plugins.

func (*Watcher) UnloadPlugin

func (w *Watcher) UnloadPlugin(id string)

UnloadPlugin unloads a loaded plugin by ID.