plugin_host_configset

package

v0.51.3 Latest Latest Go to latest Published: May 9, 2026 License: Apache-2.0 Imports: 18 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/s4wave/spacewave

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func NewFactory(b bus.Bus) controller.Factory
type Config
type Config_ConfigSetEntry
type Controller
- func (c *Controller) Execute(ctx context.Context) (rerr error)

Constants ¶

View Source

const ConfigID = ControllerID

ConfigID is the config identifier.

View Source

const ControllerID = "bldr/plugin/host/configset"

ControllerID is the controller ID.

Variables ¶

View Source

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 the factory.

Types ¶

type Config ¶

type Config struct {

	// ConfigSet is the config set to apply to the plugin host.
	ConfigSet map[string]*proto.ControllerConfig `` /* 175-byte string literal not displayed */
	// contains filtered or unexported fields
}

Config configures a controller to apply a configset to the plugin host.

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) GetConfigSet ¶

func (x *Config) GetConfigSet() map[string]*proto.ControllerConfig

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 Config_ConfigSetEntry ¶

type Config_ConfigSetEntry struct {
	Key   string                  `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	Value *proto.ControllerConfig `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*Config_ConfigSetEntry) GetKey ¶

func (x *Config_ConfigSetEntry) GetKey() string

func (*Config_ConfigSetEntry) GetValue ¶

func (x *Config_ConfigSetEntry) GetValue() *proto.ControllerConfig

func (*Config_ConfigSetEntry) MarshalJSON ¶

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

MarshalJSON marshals the Config_ConfigSetEntry to JSON.

func (*Config_ConfigSetEntry) MarshalProtoJSON ¶

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

MarshalProtoJSON marshals the Config_ConfigSetEntry message to JSON.

func (*Config_ConfigSetEntry) MarshalProtoText ¶

func (x *Config_ConfigSetEntry) MarshalProtoText() string

func (*Config_ConfigSetEntry) ProtoMessage ¶

func (*Config_ConfigSetEntry) ProtoMessage()

func (*Config_ConfigSetEntry) Reset ¶

func (x *Config_ConfigSetEntry) Reset()

func (*Config_ConfigSetEntry) String ¶

func (x *Config_ConfigSetEntry) String() string

func (*Config_ConfigSetEntry) UnmarshalJSON ¶

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

UnmarshalJSON unmarshals the Config_ConfigSetEntry from JSON.

func (*Config_ConfigSetEntry) UnmarshalProtoJSON ¶

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

UnmarshalProtoJSON unmarshals the Config_ConfigSetEntry message from JSON.

type Controller ¶

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

Controller applies a config set to the plugin host.

func (*Controller) Execute ¶

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

Execute executes the controller. Returning nil ends execution.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL