store

Documentation

Index

• type DataVersion
• type Store
  • func NewDummy() Store
  • func NewJSON(path string, reloadFn func()) (Store, error)

Types

type DataVersion

type DataVersion struct {
	Version int64 `json:"version"`
}

type Store

type Store interface {
	// Get the current configuration.
	Get() *config.Config

	// Set a new configuration for persistence.
	Set(data *config.Config) error

	// GetActive returns the configuration that has been set as
	// active before, otherwise it return nil.
	GetActive() *config.Config

	// SetActive will keep the given configuration
	// as active in memory. It can be retrieved later with GetActive()
	SetActive(data *config.Config) error

	// Reload will reload the stored configuration. It has to make sure
	// that all affected components will receiver their potentially
	// changed configuration.
	Reload() error
}

Store is a store for the configuration data.

func NewDummy

func NewDummy() Store

NewDummyStore returns a store that returns the default config

func NewJSON

func NewJSON(path string, reloadFn func()) (Store, error)

NewJSONStore will read a JSON config file from the given path. After successfully reading it in, it will be written back to the path. The returned error will be nil if everything went fine. If the path doesn't exist, a default JSON config file will be written to that path. The returned ConfigStore can be used to retrieve or write the config.