config

Documentation

Index

• type Configuration
  • func (c *Configuration) Validate() error
• type NeedsRetitle
• type PluginConfigAgent
  • func NewPluginConfigAgent() *PluginConfigAgent
  • func (pca *PluginConfigAgent) GetPlugin() *plugin.Plugin
  • func (pca *PluginConfigAgent) Load(path string) error
  • func (pca *PluginConfigAgent) Set(pc *Configuration)
  • func (pca *PluginConfigAgent) Start(path string) error

Types

type Configuration

type Configuration struct {
	NeedsRetitle NeedsRetitle `json:"needs_retitle"`
}

Configuration is the top-level serialization target for plugin Configuration.

func (*Configuration) Validate

func (c *Configuration) Validate() error

type NeedsRetitle

type NeedsRetitle struct {
	Regexp       string `json:"regexp"`
	ErrorMessage string `json:"error_message"`
}

type PluginConfigAgent

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

ConfigAgent contains the agent mutex and the Agent configuration.

func NewPluginConfigAgent

func NewPluginConfigAgent() *PluginConfigAgent

func (*PluginConfigAgent) GetPlugin

func (pca *PluginConfigAgent) GetPlugin() *plugin.Plugin

GetPlugin returns the plugin

func (*PluginConfigAgent) Load

func (pca *PluginConfigAgent) Load(path string) error

Load attempts to load config from the path. It returns an error if either the file can't be read or the configuration is invalid.

func (*PluginConfigAgent) Set

func (pca *PluginConfigAgent) Set(pc *Configuration)

Set sets the plugin agent configuration.

func (*PluginConfigAgent) Start

func (pca *PluginConfigAgent) Start(path string) error

Start starts polling path for plugin config. If the first attempt fails, then start returns the error. Future errors will halt updates but not stop.