config

Documentation

Index

• Constants
• type ClientConfig
• type Config
  • func NewConfig() *Config
  • func (c *Config) GRPCConnectionString() string
• type GRPCDConfig
• type MessagingServerConfig

Constants

const (
	ConfigFile string = "configs/client.yml"
)

Metaconfigs ...

Types

type ClientConfig

type ClientConfig struct {
	Logging *logger.ZyLogOptions
}

ClientConfig ...

type Config

type Config struct {
	Client          *ClientConfig
	MessagingServer *MessagingServerConfig
	GRPCD           *GRPCDConfig
	Logging         *logger.ZyLogOptions
}

Config ...

func NewConfig

func NewConfig() *Config

NewConfig is a constructor that creates the full coniguration data structure for use by our application(s) and client(s) as an in-memory copy of the config data (saving from having to make repeated and somewhat expensive calls to the viper library).

Note that Viper does provide both the AllSettings() and Unmarshall() functions, but these require that you have a struct defined that will be used to dump the Viper config data into. We've already got that set up, so there's no real benefit to switching.

Furthermore, in our case, we're utilizing structs from other libraries to be used when setting those up (see how we initialize the logging component in ./components/logging.go, Setup).

func (*Config) GRPCConnectionString

func (c *Config) GRPCConnectionString() string

GRPCConnectionString ...

type GRPCDConfig

type GRPCDConfig struct {
	Host string
	Port int
}

GRPCDConfig ...

type MessagingServerConfig

type MessagingServerConfig struct {
	Host string
	Port int
}

MessagingServerConfig ...