Documentation
¶
Index ¶
- Constants
- Variables
- type Config
- func (m *Config) CloneMessageVT() proto.Message
- func (m *Config) CloneVT() *Config
- func (*Config) Descriptor() ([]byte, []int)deprecated
- 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) GetApiConfig() *api.Config
- func (x *Config) GetBusApiConfig() *api1.Config
- func (c *Config) GetConfigID() string
- func (x *Config) GetDisableBusApi() bool
- func (x *Config) GetListenAddr() 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
- type Factory
Constants ¶
const ConfigID = ControllerID
ConfigID is the string used to identify this config object.
const ControllerID = "bifrost/daemon/api"
ControllerID identifies the API controller.
Variables ¶
var ( ErrInvalidLength = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflow = fmt.Errorf("proto: integer overflow") ErrUnexpectedEndOfGroup = fmt.Errorf("proto: unexpected end of group") )
var File_github_com_aperturerobotics_bifrost_daemon_api_controller_controller_proto protoreflect.FileDescriptor
var Version = semver.MustParse("0.0.1")
Version is the API version.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct { // ListenAddr is the address to listen on for connections. ListenAddr string `protobuf:"bytes,1,opt,name=listen_addr,json=listenAddr,proto3" json:"listen_addr,omitempty"` // ApiConfig are api config options. ApiConfig *api.Config `protobuf:"bytes,2,opt,name=api_config,json=apiConfig,proto3" json:"api_config,omitempty"` // DisableBusApi disables the bus api. DisableBusApi bool `protobuf:"varint,3,opt,name=disable_bus_api,json=disableBusApi,proto3" json:"disable_bus_api,omitempty"` // BusApiConfig are controller-bus bus api config options. // BusApiConfig are options for controller bus api. BusApiConfig *api1.Config `protobuf:"bytes,4,opt,name=bus_api_config,json=busApiConfig,proto3" json:"bus_api_config,omitempty"` // contains filtered or unexported fields }
Config configures the API.
func (*Config) CloneMessageVT ¶ added in v0.15.6
func (*Config) Descriptor
deprecated
func (*Config) EqualMessageVT ¶ added in v0.15.6
func (*Config) EqualsConfig ¶
EqualsConfig checks if the other config is equal.
func (*Config) GetApiConfig ¶
func (*Config) GetBusApiConfig ¶
func (*Config) GetConfigID ¶
GetConfigID returns the unique string for this configuration type. This string is stored with the encoded config.
func (*Config) GetDisableBusApi ¶
func (*Config) GetListenAddr ¶
func (*Config) MarshalToSizedBufferVT ¶ added in v0.2.0
func (*Config) ProtoMessage ¶
func (*Config) ProtoMessage()
func (*Config) ProtoReflect ¶ added in v0.2.0
func (x *Config) ProtoReflect() protoreflect.Message
func (*Config) UnmarshalVT ¶ added in v0.2.0
type Controller ¶
type Controller struct {
// contains filtered or unexported fields
}
Controller implements the API controller. The controller looks up the Node, acquires its identity, listens and responds to incoming API calls.
func NewController ¶
NewController constructs a new API 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) error
Execute executes the API controller and the listener. Returning nil ends execution. Returning an error triggers a retry with backoff.
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, di directive.Instance) ([]directive.Resolver, error)
HandleDirective asks if the handler can resolve the directive.
type Factory ¶
type Factory struct {
// contains filtered or unexported fields
}
Factory constructs a API.
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 ¶
ConstructConfig constructs an instance of the controller configuration.
func (*Factory) GetConfigID ¶
GetConfigID returns the unique ID for the config.
func (*Factory) GetControllerID ¶
GetControllerID returns the unique ID for the controller.
func (*Factory) GetVersion ¶
GetVersion returns the version of this controller.