Documentation
¶
Index ¶
- Constants
- Variables
- type Config
- 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) GetHandlePluginId() string
- func (x *Config) GetWebPkgIdList() []string
- func (x *Config) GetWebPkgIdPrefixes() []string
- func (x *Config) GetWebPkgIdRe() string
- func (x *Config) GetWebPluginId() 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 (c *Config) ParseWebPkgIdRe() (*regexp.Regexp, error)
- func (*Config) ProtoMessage()
- func (x *Config) Reset()
- func (m *Config) SizeVT() (n int)
- func (x *Config) String() string
- func (c *Config) ToRequest() *bldr_web_plugin.HandleWebPkgViaPluginRequest
- 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
- type Factory
Constants ¶
const ConfigID = ControllerID
ConfigID is the config identifier.
const ControllerID = "bldr/web/plugin/handle-web-pkg-rpc"
ControllerID is the controller ID.
Variables ¶
var Version = controller.MustParseVersion("0.0.1")
Version is the version of this controller.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// WebPluginId is the id of the web plugin.
WebPluginId string `protobuf:"bytes,1,opt,name=web_plugin_id,json=webPluginId,proto3" json:"webPluginId,omitempty"`
// HandlePluginId is the plugin the web plugin should send LookupWebPkg to.
HandlePluginId string `protobuf:"bytes,2,opt,name=handle_plugin_id,json=handlePluginId,proto3" json:"handlePluginId,omitempty"`
// WebPkgIdRe is a regex string to match web pkgs IDs.
// Set to '.*' or empty to match all web pkgs ids.
WebPkgIdRe string `protobuf:"bytes,3,opt,name=web_pkg_id_re,json=webPkgIdRe,proto3" json:"webPkgIdRe,omitempty"`
// WebPkgIdPrefixes is a list of web pkg id prefixes to match.
// If the value is in this list, overrides web_pkg_id_re.
// Set to '.*' or empty to match all web pkgs ids.
WebPkgIdPrefixes []string `protobuf:"bytes,4,rep,name=web_pkg_id_prefixes,json=webPkgIdPrefixes,proto3" json:"webPkgIdPrefixes,omitempty"`
// WebPkgIdList is a list of web pkg IDs to resolve.
// If the value is in this list, overrides web_pkg_id_re and web_pkg_id_prefixes.
// Ignored if empty.
WebPkgIdList []string `protobuf:"bytes,5,rep,name=web_pkg_id_list,json=webPkgIdList,proto3" json:"webPkgIdList,omitempty"`
// contains filtered or unexported fields
}
Config configures a controller to forward LookupWebPkg to a plugin. webPluginId should correspond to a bldr/web/plugin plugin. Resolves the LookupWebPkg directive on the web plugin bus.
func (*Config) CloneMessageVT ¶
func (m *Config) CloneMessageVT() protobuf_go_lite.CloneMessage
func (*Config) EqualMessageVT ¶
func (*Config) EqualsConfig ¶
EqualsConfig checks if the config is equal to another.
func (*Config) GetConfigID ¶
GetConfigID returns the unique string for this configuration type.
func (*Config) GetHandlePluginId ¶
func (*Config) GetWebPkgIdList ¶
func (*Config) GetWebPkgIdPrefixes ¶
func (*Config) GetWebPkgIdRe ¶
func (*Config) GetWebPluginId ¶
func (*Config) MarshalJSON ¶
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 (*Config) MarshalToSizedBufferVT ¶
func (*Config) ParseWebPkgIdRe ¶
ParseWebPkgIdRe parses the handle web view id regex. Returns nil if the field was empty.
func (*Config) ProtoMessage ¶
func (*Config) ProtoMessage()
func (*Config) ToRequest ¶
func (c *Config) ToRequest() *bldr_web_plugin.HandleWebPkgViaPluginRequest
ToRequest converts the config into a request.
func (*Config) UnmarshalJSON ¶
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 ¶
type Controller ¶
type Controller struct {
// contains filtered or unexported fields
}
Controller calls the web plugin to enable forwarding web pkg lookups to the handler plugin.
func NewController ¶
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) HandleDirective ¶
func (c *Controller) HandleDirective( ctx context.Context, inst directive.Instance, ) ([]directive.Resolver, error)
HandleDirective asks if the handler can resolve the directive.
Source Files