Documentation
¶
Index ¶
- Constants
- type Configurer
- type General
- type Viper
- func (v *Viper) Available()
- func (v *Viper) Get(name string) interface{}
- func (v *Viper) GetCommonConfig() *General
- func (v *Viper) Has(name string) bool
- func (v *Viper) Init() error
- func (v *Viper) Name() string
- func (v *Viper) Overwrite(values map[string]interface{}) error
- func (v *Viper) Serve() chan error
- func (v *Viper) Stop() error
- func (v *Viper) Unmarshal(out interface{}) error
- func (v *Viper) UnmarshalKey(name string, out interface{}) error
Constants ¶
View Source
const PluginName string = "config"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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
// internal, RRVersion from the rr-binary
RRVersion string
}
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 Viper ¶
type Viper 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 RR-Endure.
RRVersion string
CommonConfig *General
// contains filtered or unexported fields
}
func (*Viper) GetCommonConfig ¶
GetCommonConfig Returns common config parameters
func (*Viper) UnmarshalKey ¶
UnmarshalKey reads configuration section into configuration object.
Click to show internal directories.
Click to hide internal directories.