bldr_plugin_forward_rpc_service

package
v0.52.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 2, 2026 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Index

Constants

View Source 
const ConfigID = ControllerID

ConfigID is the config identifier.

View Source 
const ControllerID = "bldr/plugin/forward-rpc-service"

ControllerID is the controller ID.

Variables

View Source 
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 {

	// PluginId is the plugin to load and use as AccessRpcService.
	PluginId string `protobuf:"bytes,1,opt,name=plugin_id,json=pluginId,proto3" json:"pluginId,omitempty"`
	// ServiceIdRe is the regex of service IDs to forward.
	// If empty, will forward any.
	ServiceIdRe string `protobuf:"bytes,2,opt,name=service_id_re,json=serviceIdRe,proto3" json:"serviceIdRe,omitempty"`
	// ServerIdRe is the regex of server IDs to forward for.
	// If empty, will forward any.
	ServerIdRe string `protobuf:"bytes,3,opt,name=server_id_re,json=serverIdRe,proto3" json:"serverIdRe,omitempty"`
	// Backoff is the backoff config for calling the RPC service.
	// If unset, defaults to reasonable defaults.
	Backoff *backoff.Backoff `protobuf:"bytes,4,opt,name=backoff,proto3" json:"backoff,omitempty"`
	// contains filtered or unexported fields
}

Config configures forwarding rpc services to plugins. Loads a plugin with LoadPlugin and uses its RPC client. Calls the AccessRpcService service. Resolves the LookupRpcService directive.

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

func (x *Config) GetBackoff() *backoff.Backoff

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

func (x *Config) GetServerIdRe() string

func (*Config) GetServiceIdRe 

func (x *Config) GetServiceIdRe() 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) ParseServerIdRe 

func (c *Config) ParseServerIdRe() (*regexp.Regexp, error)

ParseServerIdRe parses the server id regex. Returns nil if the field was empty.

func (*Config) ParseServiceIdRe 

func (c *Config) ParseServiceIdRe() (*regexp.Regexp, error)

ParseServiceIdRe parses the service id regex. Returns nil if the field was empty.

func (*Config) ProtoMessage 

func (*Config) ProtoMessage()

func (*Config) Reset 

func (x *Config) Reset()

func (*Config) SetServerIdRe 

func (c *Config) SetServerIdRe(re string)

SetServerIdRe sets the server id regex.

func (*Config) SetServiceIdRe 

func (c *Config) SetServiceIdRe(re string)

SetServiceIdRe sets the service id regex.

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 {
	*bifrost_rpc_access.ClientController
	// contains filtered or unexported fields
}

Controller forwards RPC services to a remote plugin.

func NewController 

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

NewController constructs a new controller.

func (*Controller) PluginLoadAccessClient 

func (c *Controller) PluginLoadAccessClient(
	ctx context.Context,
	released func(),
) (bifrost_rpc_access.SRPCAccessRpcServiceClient, func(), error)

PluginLoadAccessClient adds a reference to the plugin and waits for it to be built.

type Factory 

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

Factory constructs a rpc forwarding controller factory.

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() controller.Version

GetVersion returns the version of this controller.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.