web

Documentation

Index

• Constants
• type Config
  • func GetDefaultConfig() *Config
  • func (web *Config) SocketAddress() string
  • func (web *Config) ValidateAndSetDefaults() error

Constants

const (
	// DefaultAddress is the default address the service will bind to
	DefaultAddress = "0.0.0.0"

	// DefaultPort is the default port the service will listen on
	DefaultPort = 8080
)

Types

type Config

type Config struct {
	// Address to listen on (defaults to 0.0.0.0 specified by DefaultAddress)
	Address string `yaml:"address"`

	// Port to listen on (default to 8080 specified by DefaultPort)
	Port int `yaml:"port"`
}

Config is the structure which supports the configuration of the endpoint which provides access to the web frontend

func GetDefaultConfig

func GetDefaultConfig() *Config

GetDefaultConfig returns a Config struct with the default values

func (*Config) SocketAddress

func (web *Config) SocketAddress() string

SocketAddress returns the combination of the Address and the Port

func (*Config) ValidateAndSetDefaults

func (web *Config) ValidateAndSetDefaults() error

ValidateAndSetDefaults validates the web configuration and sets the default values if necessary.