Documentation ¶
Index ¶
- Constants
- Variables
- type Config
- func (*Config) Descriptor() ([]byte, []int)
- func (c *Config) EqualsConfig(c2 config.Config) bool
- func (c *Config) GetConfigID() string
- func (*Config) ProtoMessage()
- func (m *Config) Reset()
- func (m *Config) String() string
- func (c *Config) Validate() error
- func (m *Config) XXX_DiscardUnknown()
- func (m *Config) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Config) XXX_Merge(src proto.Message)
- func (m *Config) XXX_Size() int
- func (m *Config) XXX_Unmarshal(b []byte) error
- type Controller
- func (c *Controller) AddConfigSetReference(ctx context.Context, key string) (configset.Reference, error)
- func (c *Controller) Close() error
- func (c *Controller) Execute(ctx context.Context) error
- func (c *Controller) GetControllerInfo() controller.Info
- func (c *Controller) HandleDirective(ctx context.Context, di directive.Instance) (directive.Resolver, error)
- func (c *Controller) PushControllerConfig(ctx context.Context, key string, conf configset.ControllerConfig) (configset.Reference, error)
- type Factory
Constants ¶
const ConfigID = ControllerID
ConfigID is the identifier for the config type.
const ControllerID = "controllerbus/configset/1"
ControllerID is the ID of the controller.
Variables ¶
var Version = semver.MustParse("0.0.1")
Version is the version of the controller implementation.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct { XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Config is the configset controller configuration.
func (*Config) Descriptor ¶
func (*Config) EqualsConfig ¶
EqualsConfig checks equality between two configs.
func (*Config) GetConfigID ¶
GetConfigID returns the config identifier.
func (*Config) ProtoMessage ¶
func (*Config) ProtoMessage()
func (*Config) XXX_DiscardUnknown ¶
func (m *Config) XXX_DiscardUnknown()
func (*Config) XXX_Marshal ¶
func (*Config) XXX_Unmarshal ¶
type Controller ¶
type Controller struct {
// contains filtered or unexported fields
}
Controller is the ConfigSet controller.
func NewController ¶
NewController constructs a new peer controller. If privKey is nil, one will be generated.
func (*Controller) AddConfigSetReference ¶
func (c *Controller) AddConfigSetReference( ctx context.Context, key string, ) (configset.Reference, error)
AddConfigSetReference adds a persistent reference to a config set which will be re-applied across iterations. This reference type will wait until a ApplyConfigSet specifies the configuration for the controller, and will add to the reference count for the controller such that the controller will continue to execute after the ApplyConfigSet call exits.
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 given controller. 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. If it can, it returns a resolver. If not, returns nil. Any exceptional errors are returned for logging. It is safe to add a reference to the directive during this call.
func (*Controller) PushControllerConfig ¶
func (c *Controller) PushControllerConfig( ctx context.Context, key string, conf configset.ControllerConfig, ) (configset.Reference, error)
PushControllerConfig pushes a controller configuration for a given key, if the version is newer. Returns a reference to the configset, or an error.
type Factory ¶
type Factory struct {
// contains filtered or unexported fields
}
Factory constructs a configset controller.
func NewFactory ¶
NewFactory builds a configset controller 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 ¶
ConstructConfig constructs an instance of the controller configuration.
func (*Factory) GetConfigID ¶
GetConfigID returns the configuration ID for the controller.
func (*Factory) GetControllerID ¶
GetControllerID returns the unique ID for the controller.
func (*Factory) GetVersion ¶
GetVersion returns the version of this controller.