configapi

Documentation

Index

• func SelectorsHelperCache(s *Selectors)
• func SelectorsHelperCacheValue(s *Selectors) string
• type AcquireConfigurationFailRes
• type AcquireConfigurationReq
• type AcquireConfigurationRes
• type Configuration
  • func (c *Configuration) GenerateSignature() string
  • func (c *Configuration) ValidateSignature() bool
• type DataPump
• type DataWriter
• type Event
• type GetConfigurationRes
• type PublishReq
• type PublishRes
• type RawConfiguration
• type RequestedConfigurationKey
• type Selectors
  • func (s *Selectors) Fill(str string) error
• type VersionComparator

Functions

func SelectorsHelperCache

func SelectorsHelperCache(s *Selectors)

func SelectorsHelperCacheValue

func SelectorsHelperCacheValue(s *Selectors) string

Types

type AcquireConfigurationFailRes

type AcquireConfigurationFailRes struct {
	Code     string   `cbor:"code,"`
	Message  string   `cbor:"msg,"`
	InfoList []string `cbor:"info_list,"`
}

type AcquireConfigurationReq

type AcquireConfigurationReq struct {
	Requested         []RequestedConfigurationKey `cbor:"req,"`
	Selectors         Selectors                   `cbor:"selectors,"`
	OptionalSelectors Selectors                   `cbor:"opt_selectors,"`
}

type AcquireConfigurationRes

type AcquireConfigurationRes struct {
	Requested []Configuration `cbor:"req,"`
}

type Configuration

type Configuration struct {
	// Group is a set of configurations
	Group string `cbor:"group,"`
	// Key is the name of the configuration
	Key string `cbor:"key,"`
	// Version represents the unique configuration history
	Version string `cbor:"version,"`

	// Value is the complete data of the configuration
	Value []byte `cbor:"value,"`
	// Signature represents the data integrity of the configuration
	Signature string `cbor:"sign,"`
	// Selector represents the part where the configuration will be used
	Selectors Selectors `cbor:"selectors,"`
	// OptionalSelectors is used for optional selectors matching
	OptionalSelectors Selectors `cbor:"opt_selectors,"`
	// Timestamp is the unix timestamp in second of the effective time(create/update) of this configuration
	Timestamp int64 `cbor:"timestamp,"`
}

func (*Configuration) GenerateSignature

func (c *Configuration) GenerateSignature() string

func (*Configuration) ValidateSignature

func (c *Configuration) ValidateSignature() bool

type DataPump

type DataPump interface {
	Startup() error
	Stop() error
	EventChannel() <-chan Event
	TriggerDumpToChannel() <-chan Event
}

type DataWriter

type DataWriter interface {
	Startup() error
	Stop() error
	SaveConfiguration(cfg Configuration) error
	DeleteConfiguration(group, key, sel, optSel string) (bool, error)
}

type Event

type Event struct {
	Configuration *Configuration

	Created  bool
	Modified bool
	Deleted  bool
}

type GetConfigurationRes

type GetConfigurationRes struct {
	Code          string        `cbor:"code,"`
	Message       string        `cbor:"msg,"`
	Configuration Configuration `cbor:"cfg"`
}

type PublishReq

type PublishReq struct {
	Configuration     RawConfiguration `cbor:"cfg,"`
	Selectors         Selectors        `cbor:"selectors,"`
	OptionalSelectors Selectors        `cbor:"opt_selectors,"`
	Operator          string           `cbor:"operator,"`
	Description       string           `cbor:"description"`
}

type PublishRes

type PublishRes struct {
	Success bool   `cbor:"success,"`
	Code    string `cbor:"code,"`
	Message string `cbor:"message,"`
}

type RawConfiguration

type RawConfiguration struct {
	Group   string `cbor:"group,"`
	Key     string `cbor:"key,"`
	Version string `cbor:"version,"`
	Value   []byte `cbor:"value,"`
}

type RequestedConfigurationKey

type RequestedConfigurationKey struct {
	Group   string `cbor:"group,"`
	Key     string `cbor:"key,"`
	Version string `cbor:"version,"`
}

type Selectors

type Selectors struct {
	Data map[string]string `cbor:"data,"`
	// contains filtered or unexported fields
}

func (*Selectors) Fill

func (s *Selectors) Fill(str string) error

type VersionComparator

type VersionComparator interface {
	HasUpdate(requestVersion, dataVersion string) bool
}