stream_srpc_client_controller

Documentation

Index

• Constants
• Variables
• type Config
  • func (m *Config) CloneMessageVT() proto.Message
  • func (m *Config) CloneVT() *Config
  • func (*Config) Descriptor() ([]byte, []int)
  • func (this *Config) EqualMessageVT(thatMsg proto.Message) bool
  • func (this *Config) EqualVT(that *Config) bool
  • func (c *Config) EqualsConfig(other config.Config) bool
  • func (x *Config) GetClient() *client.Config
  • func (c *Config) GetConfigID() string
  • func (x *Config) GetProtocolId() string
  • func (x *Config) GetServiceIdPrefixes() []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) ProtoReflect() protoreflect.Message
  • func (x *Config) Reset()
  • func (m *Config) SizeVT() (n int)
  • func (x *Config) String() string
  • 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)
• type Factory
  • func NewFactory(bus bus.Bus) *Factory
  • func (t *Factory) Construct(conf config.Config, opts controller.ConstructOpts) (controller.Controller, error)
  • func (t *Factory) ConstructConfig() config.Config
  • func (t *Factory) GetConfigID() string
  • func (t *Factory) GetControllerID() string
  • func (t *Factory) GetVersion() semver.Version

Constants

const ConfigID = ControllerID

ConfigID is the config identifier.

const ControllerID = "bifrost/stream/srpc/client"

ControllerID is the controller ID.

Variables

var File_github_com_aperturerobotics_bifrost_stream_srpc_client_controller_config_proto protoreflect.FileDescriptor

var Version = semver.MustParse("0.0.1")

Version is the version of this controller.

Types

type Config

type Config struct {

	// Client contains srpc.client configuration for the RPC client.
	Client *client.Config `protobuf:"bytes,1,opt,name=client,proto3" json:"client,omitempty"`
	// ProtocolId is the protocol ID to use to contact the remote RPC service.
	// Must be set.
	ProtocolId string `protobuf:"bytes,2,opt,name=protocol_id,json=protocolId,proto3" json:"protocol_id,omitempty"`
	// ServiceIdPrefixes are the service ID prefixes to match.
	// The prefix will be stripped from the service id before being passed to the client.
	// This is used like: LookupRpcClient<remote/my/service> -> my/service.
	//
	// If empty slice or empty string: matches all LookupRpcClient calls ignoring service ID.
	// Optional.
	ServiceIdPrefixes []string `protobuf:"bytes,3,rep,name=service_id_prefixes,json=serviceIdPrefixes,proto3" json:"service_id_prefixes,omitempty"`
	// contains filtered or unexported fields
}

Config configures mounting a bifrost srpc RPC client to a bus. Resolves the LookupRpcClient directive.

func (*Config) CloneMessageVT

func (m *Config) CloneMessageVT() proto.Message

func (*Config) CloneVT

func (m *Config) CloneVT() *Config

func (*Config) Descriptor

func (*Config) Descriptor() ([]byte, []int)

Deprecated: Use Config.ProtoReflect.Descriptor instead.

func (*Config) EqualMessageVT

func (this *Config) EqualMessageVT(thatMsg proto.Message) 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) GetClient

func (x *Config) GetClient() *client.Config

func (*Config) GetConfigID

func (c *Config) GetConfigID() string

GetConfigID returns the unique string for this configuration type.

func (*Config) GetProtocolId

func (x *Config) GetProtocolId() string

func (*Config) GetServiceIdPrefixes

func (x *Config) GetServiceIdPrefixes() []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) ProtoReflect

func (x *Config) ProtoReflect() protoreflect.Message

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

Controller mounts a bifrost stream srpc client to a bus.

func NewController

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

NewController constructs a new controller.

type Factory

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

Factory constructs a controller factory.

func NewFactory

func NewFactory(bus bus.Bus) *Factory

NewFactory builds the factory.

func (*Factory) Construct

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