bldr_web_plugin_browser_controller

package

v0.51.4 Latest Latest Go to latest Published: May 9, 2026 License: Apache-2.0 Imports: 20 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
type Config
type Controller
- func NewController(le *logrus.Entry, bus bus.Bus, conf *Config) *Controller
type Factory
- func NewFactory(bus bus.Bus) *Factory

Constants ¶

View Source

const ConfigID = ControllerID

ConfigID is the config identifier.

View Source

const ControllerID = "bldr/web/plugin/browser/controller"

ControllerID is the controller ID.

Variables ¶

View Source

var Version = semver.MustParse("0.0.1")

Version is the version of this controller.

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {

	// ServiceId is the service id to expose the WebPluginBrowserHost service.
	// If unset, defaults to bldr.web.plugin.browser.WebPluginBrowserHost
	ServiceId string `protobuf:"bytes,1,opt,name=service_id,json=serviceId,proto3" json:"serviceId,omitempty"`
	// contains filtered or unexported fields
}

Config configures the web plugin browser host controller. Serves the WebPluginBrowserHost service.

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

func (x *Config) GetServiceId() 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 {
	// contains filtered or unexported fields
}

Controller manages running the web plugin browser host. Serves the WebPluginBrowserHost RPC service.

func NewController ¶

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

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) (rerr error)

Execute executes the controller. Returning nil ends execution.

func (*Controller) GetControllerInfo ¶

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

GetControllerInfo returns information about the controller.

func (*Controller) GetServiceID ¶

func (c *Controller) GetServiceID() string

GetServiceID returns the ServiceID the controller will respond to.

func (*Controller) HandleDirective ¶

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

HandleDirective asks if the handler can resolve the directive.

func (*Controller) InvokeMethod ¶

func (c *Controller) InvokeMethod(serviceID, methodID string, strm srpc.Stream) (bool, error)

InvokeMethod invokes the method matching the service & method ID. Returns false, nil if not found. If service string is empty, ignore it.

func (*Controller) PluginRpc ¶

func (c *Controller) PluginRpc(strm bldr_web_plugin_browser.SRPCWebPluginBrowserHost_PluginRpcStream) error

PluginRpc handles an incoming RPC request for the web plugin from a remote plugin.

type Factory ¶

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

Factory constructs the controller.

func NewFactory ¶

func NewFactory(bus bus.Bus) *Factory

NewFactory builds the factory.

func (*Factory) Construct ¶

func (t *Factory) Construct(
	ctx context.Context,
	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.

Source Files ¶

View all Source files

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