bldr_plugin_load

Documentation

Index

• Constants
• Variables
• func NewFactory(b bus.Bus) controller.Factory
• type Config
  • func NewConfig() *Config
  • func (c *Config) CleanupPluginIds() []string
  • func (m *Config) CloneMessageVT() protobuf_go_lite.CloneMessage
  • func (m *Config) CloneVT() *Config
  • func (this *Config) EqualMessageVT(thatMsg any) bool
  • func (this *Config) EqualVT(that *Config) bool
  • func (c *Config) EqualsConfig(other config.Config) bool
  • func (c *Config) GetConfigID() string
  • func (x *Config) GetPluginId() string
  • func (x *Config) GetPluginIds() []string
  • func (x *Config) MarshalJSON() ([]byte, error)
  • func (x *Config) MarshalProtoJSON(s *json.MarshalState)
  • func (x *Config) MarshalProtoText() string
  • 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) Reset()
  • func (m *Config) SizeVT() (n int)
  • func (x *Config) String() string
  • func (x *Config) UnmarshalJSON(b []byte) error
  • func (x *Config) UnmarshalProtoJSON(s *json.UnmarshalState)
  • func (m *Config) UnmarshalVT(dAtA []byte) error
  • func (c *Config) Validate() error
• type Controller
  • func NewController(le *logrus.Entry, b bus.Bus, conf *Config) (*Controller, error)
  • func (c *Controller) Execute(ctx context.Context) error

Constants

const ConfigID = ControllerID

ConfigID is the config identifier.

const ControllerID = "bldr/plugin/load"

ControllerID is the controller ID.

Variables

var Version = semver.MustParse("0.0.1")

Version is the version of this controller.

Functions

func NewFactory

func NewFactory(b bus.Bus) controller.Factory

NewFactory constructs a new load plugin controller.

Types

type Config

type Config struct {

	// PluginId is the plugin to load.
	PluginId string `protobuf:"bytes,1,opt,name=plugin_id,json=pluginId,proto3" json:"pluginId,omitempty"`
	// PluginIds is a list of plugins to load.
	// Appended to plugin_id.
	PluginIds []string `protobuf:"bytes,2,rep,name=plugin_ids,json=pluginIds,proto3" json:"pluginIds,omitempty"`
	// contains filtered or unexported fields
}

Config configures loading a plugin with the LoadPlugin directive.

func NewConfig

func NewConfig() *Config

NewConfig constructs a new config.

func (*Config) CleanupPluginIds

func (c *Config) CleanupPluginIds() []string

CleanupPluginIds returns a sorted copy of the list of plugin IDs to load.

func (*Config) CloneMessageVT

func (m *Config) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*Config) CloneVT

func (m *Config) CloneVT() *Config

func (*Config) EqualMessageVT

func (this *Config) EqualMessageVT(thatMsg any) bool

func (*Config) EqualVT

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

func (*Config) EqualsConfig

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

EqualsConfig checks if the config is equal to another.

func (*Config) GetConfigID

func (c *Config) GetConfigID() string

GetConfigID returns the unique string for this configuration type.

func (*Config) GetPluginId

func (x *Config) GetPluginId() string

func (*Config) GetPluginIds

func (x *Config) GetPluginIds() []string

func (*Config) MarshalJSON

func (x *Config) MarshalJSON() ([]byte, error)

MarshalJSON marshals the Config to JSON.

func (*Config) MarshalProtoJSON

func (x *Config) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the Config message to JSON.

func (*Config) MarshalProtoText

func (x *Config) MarshalProtoText() string

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) Reset

func (x *Config) Reset()

func (*Config) SizeVT

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

func (*Config) String

func (x *Config) String() string

func (*Config) UnmarshalJSON

func (x *Config) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the Config from JSON.

func (*Config) UnmarshalProtoJSON

func (x *Config) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the Config message from JSON.

func (*Config) UnmarshalVT

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

func (*Config) Validate

func (c *Config) Validate() error

Validate checks the config.

type Controller

type Controller struct {
	*bus.BusController[*Config]
}

Controller creates a LoadPlugin directive.

func NewController

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

NewController constructs a new load plugin controller.

func (*Controller) Execute

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

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