s

Documentation

Index

• Constants
• func CheckSettingsFilePath(sfp cm.Path) (err error)
• func DetailedScsError(serviceShortName string, errIn error) (errOut error)
• func GetPasswordFromStdin(hint string) (pwd string, err error)
• type DbSettings
  • func (dbs DbSettings) Check() (err error)
• type HttpSettings
  • func (hs HttpSettings) Check() (err error)
• type HttpsSettings
  • func (hss HttpsSettings) Check() (err error)
• type ServiceClientSettings
  • func (scs ServiceClientSettings) Check() (err error)

Constants

const (
	ErrDbDriverName             = "DB driver name is not set"
	ErrDbNet                    = "DB net is not set"
	ErrDbHost                   = "DB host is not set"
	ErrDbPort                   = "DB port is not set"
	ErrDbName                   = "DB name is not set"
	ErrDbUser                   = "DB user is not set"
	ErrDbMaxAllowedPacket       = "DB MaxAllowedPacket is not set"
	ErrDbTableInitScriptsFolder = "DB TableInitScriptsFolder is not set"
)

const (
	ErrHttpHost = "HTTP host is not set"
	ErrHttpPort = "HTTP port is not set"
)

const (
	ErrHttpsHost     = "HTTPS host is not set"
	ErrHttpsPort     = "HTTPS port is not set"
	ErrHttpsCertFile = "HTTPS CertFile is not set"
	ErrHttpsKeyFile  = "HTTPS KeyFile is not set"
)

const (
	ErrScsSchema = "SCS schema is not set"
	ErrScsHost   = "SCS host is not set"
	ErrScsPort   = "SCS port is not set"
	ErrScsPath   = "SCS path is not set"
)

const (
	RpcDurationFieldName  = "dur"
	RpcRequestIdFieldName = "rid"
)

const (
	ErrSettingsFileIsNotSet = "settings file is not set"
)

Functions

func CheckSettingsFilePath

func CheckSettingsFilePath(sfp cm.Path) (err error)

func DetailedScsError

func DetailedScsError(serviceShortName string, errIn error) (errOut error)

func GetPasswordFromStdin

func GetPasswordFromStdin(hint string) (pwd string, err error)

Types

type DbSettings

type DbSettings struct {
	// Access settings.
	DriverName string `json:"driverName"`
	Net        string `json:"net"`
	Host       string `json:"host"`
	Port       uint16 `json:"port"`
	DBName     string `json:"dbName"`
	User       string `json:"user"`
	Password   string `json:"password"`

	// Various specific MySQL settings.
	AllowNativePasswords bool              `json:"allowNativePasswords"`
	CheckConnLiveness    bool              `json:"checkConnLiveness"`
	MaxAllowedPacket     int               `json:"maxAllowedPacket"`
	Params               map[string]string `json:"params"`

	// Database structure and initialisation settings.
	TableNamePrefix        string   `json:"tableNamePrefix"`
	TablesToInit           []string `json:"tablesToInit"`
	TableInitScriptsFolder string   `json:"tableInitScriptsFolder"`
}

DbSettings are parameters of a MySQL database together with some other settings related to database infrastructure. When a password is not set, it is taken from the stdin.

func (DbSettings) Check

func (dbs DbSettings) Check() (err error)

type HttpSettings

type HttpSettings struct {
	Host string `json:"host"`
	Port uint16 `json:"port"`
}

HttpSettings are settings of a generic HTTP server.

func (HttpSettings) Check

func (hs HttpSettings) Check() (err error)

type HttpsSettings

type HttpsSettings struct {
	Host     string `json:"host"`
	Port     uint16 `json:"port"`
	CertFile string `json:"certFile"`
	KeyFile  string `json:"keyFile"`
}

HttpsSettings are settings of a generic HTTPS server.

func (HttpsSettings) Check

func (hss HttpsSettings) Check() (err error)

type ServiceClientSettings

type ServiceClientSettings struct {
	Schema                      string `json:"schema"`
	Host                        string `json:"host"`
	Port                        uint16 `json:"port"`
	Path                        string `json:"path"`
	EnableSelfSignedCertificate bool   `json:"enableSelfSignedCertificate"`
}

ServiceClientSettings are common settings for a service client.

func (ServiceClientSettings) Check

func (scs ServiceClientSettings) Check() (err error)

Check checks common settings of a service client.