listenaddress

Documentation

Overview

Package listenaddress provides a configuration struct for resolving a listen address from YAML.

Index

• type Configuration
  • func (c Configuration) Resolve() (string, error)
• type Resolver

Types

type Configuration

type Configuration struct {
	// ListenAddressType is the port type for the port
	ListenAddressType Resolver `yaml:"type" validate:"nonzero"`

	// Value is the config specified listen address if using config port type.
	Value *string `yaml:"value"`

	// EnvVarListenPort specifies the environment variable name for the listen address port.
	EnvVarListenPort *string `yaml:"envVarListenPort"`

	// EnvVarListenHost specifies the environment variable name for the listen address hostname.
	EnvVarListenHost *string `yaml:"envVarListenHost"`
}

Configuration is the configuration for resolving a listen address.

func (Configuration) Resolve

func (c Configuration) Resolve() (string, error)

Resolve returns the resolved listen address given the configuration.

type Resolver

type Resolver string

Resolver is a type of port resolver

const (
	// ConfigResolver resolves port using a value provided in config
	ConfigResolver Resolver = "config"
	// EnvironmentResolver resolves port using an environment variable
	// of which the name is provided in config
	EnvironmentResolver Resolver = "environment"
)