config

Documentation

Index

• Constants
• type Configurer
• type General
• type Plugin
  • func (p *Plugin) Get(name string) interface{}
  • func (p *Plugin) GetCommonConfig() *General
  • func (p *Plugin) Has(name string) bool
  • func (p *Plugin) Init() error
  • func (p *Plugin) Name() string
  • func (p *Plugin) Overwrite(values map[string]interface{}) error
  • func (p *Plugin) Serve() chan error
  • func (p *Plugin) Stop() error
  • func (p *Plugin) Unmarshal(out interface{}) error
  • func (p *Plugin) UnmarshalKey(name string, out interface{}) error

Constants

const (
	PluginName string = "config"
)

Types

type Configurer

type Configurer interface {
	// UnmarshalKey takes a single key and unmarshals it into a Struct.
	//
	// func (h *HttpService) Init(cp config.Configurer) error {
	//     h.config := &HttpConfig{}
	//     if err := configProvider.UnmarshalKey("http", h.config); err != nil {
	//         return err
	//     }
	// }
	UnmarshalKey(name string, out interface{}) error

	// Unmarshal unmarshal the config into a Struct. Make sure that the tags
	// on the fields of the structure are properly set.
	Unmarshal(out interface{}) error

	// Get used to get config section
	Get(name string) interface{}

	// Overwrite used to overwrite particular values in the unmarshalled config
	Overwrite(values map[string]interface{}) error

	// Has checks if config section exists.
	Has(name string) bool

	// GetCommonConfig returns General section. Read-only
	GetCommonConfig() *General
}

type General

type General struct {
	// GracefulTimeout for the temporal and http
	GracefulTimeout time.Duration

	// RRVersion passed from the rr-binary
	RRVersion *version.Version
}

General is the part of the config plugin which contains general for the whole RR2 parameters For example - http timeouts, headers sizes etc and also graceful shutdown timeout should be the same across whole application

type Plugin

type Plugin struct {
	Path      string
	Prefix    string
	Type      string
	ReadInCfg []byte
	// user defined Flags in the form of <option>.<key> = <value>
	// which overwrites initial config key
	Flags []string

	// RRVersion passed from the Endure.
	RRVersion string

	// All plugins common parameters
	CommonConfig *General
	// contains filtered or unexported fields
}

func (*Plugin) Get

func (p *Plugin) Get(name string) interface{}

Get raw config in a form of config section.

func (*Plugin) GetCommonConfig

func (p *Plugin) GetCommonConfig() *General

GetCommonConfig Returns common config parameters

func (*Plugin) Has

func (p *Plugin) Has(name string) bool

Has checks if config section exists.

func (*Plugin) Init

func (p *Plugin) Init() error

Init config provider.

func (*Plugin) Name

func (p *Plugin) Name() string

Name returns user-friendly plugin name

func (*Plugin) Overwrite

func (p *Plugin) Overwrite(values map[string]interface{}) error

Overwrite overwrites existing config with provided values

func (*Plugin) Serve

func (p *Plugin) Serve() chan error

func (*Plugin) Stop

func (p *Plugin) Stop() error

func (*Plugin) Unmarshal

func (p *Plugin) Unmarshal(out interface{}) error

func (*Plugin) UnmarshalKey

func (p *Plugin) UnmarshalKey(name string, out interface{}) error

UnmarshalKey reads configuration section into configuration object.