Help us shape the future of Go! Take the 2026 Go Developer Survey

config

package
v2.6.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 3, 2021 License: MIT Imports: 7 Imported by: 3

Documentation

Index

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
}

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) Get

func (v *Viper) Get(name string) interface{}

Get raw config in a form of config section.

func (*Viper) GetCommonConfig

func (v *Viper) GetCommonConfig() *General

GetCommonConfig Returns common config parameters

func (*Viper) Has

func (v *Viper) Has(name string) bool

Has checks if config section exists.

func (*Viper) Init

func (v *Viper) Init() error

Init config provider.

func (*Viper) Name

func (v *Viper) Name() string

Name returns user-friendly plugin name

func (*Viper) Overwrite

func (v *Viper) Overwrite(values map[string]interface{}) error

Overwrite overwrites existing config with provided values

func (*Viper) Serve

func (v *Viper) Serve() chan error

func (*Viper) Stop

func (v *Viper) Stop() error

func (*Viper) Unmarshal

func (v *Viper) Unmarshal(out interface{}) error

func (*Viper) UnmarshalKey

func (v *Viper) UnmarshalKey(name string, out interface{}) error

UnmarshalKey reads configuration section into configuration object.

Directories

Path Synopsis
configs

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL