config

Documentation

Index

• type Config
  • func Default() *Config
  • func FromFile(path string) (*Config, error)
• type EnforcementPolicy
  • func (e EnforcementPolicy) Object() keepalive.EnforcementPolicy
• type Grpc
• type Http
• type KeepAlive
• type Ports
• type ServerParameters
  • func (s ServerParameters) Object() keepalive.ServerParameters
• type Timeout

Types

type Config

type Config struct {
	Http Http `yaml:"http"`
	Grpc Grpc `yaml:"grpc"`
}

Config allows configuring HTTP Server

func Default

func Default() *Config

Default resets all fields to the default configuration.

func FromFile

func FromFile(path string) (*Config, error)

FromFile loads the application configuration from the file system.

type EnforcementPolicy

type EnforcementPolicy struct {
	MinTime             time.Duration `yaml:"minTime"`
	PermitWithoutStream bool          `yaml:"permitWithoutStream"`
}

func (EnforcementPolicy) Object

func (e EnforcementPolicy) Object() keepalive.EnforcementPolicy

type Grpc

type Grpc struct {
	Network     string                   `yaml:"network"`
	Address     string                   `yaml:"address"`
	Certificate *certificate.Certificate `yaml:"certificate"`
	KeepAlive   KeepAlive                `yaml:"keepAlive"`
}

type Http

type Http struct {
	Ports          Ports                    `yaml:"ports"`
	Timeout        Timeout                  `yaml:"timeout"`
	Connection     *tcp.Connection          `yaml:"connection"`
	Certificate    *certificate.Certificate `yaml:"certificate"`
	MaxHeaderBytes int                      `yaml:"maxHeaderBytes"`
}

type KeepAlive

type KeepAlive struct {
	EnforcementPolicy EnforcementPolicy `yaml:"enforcementPolicy"`
	ServerParameters  ServerParameters  `yaml:"serverParameters"`
}

type Ports

type Ports struct {
	HTTP  int `yaml:"http"`
	HTTPS int `yaml:"https"`
}

Ports allows to configure the ports that Airborne will listen on.

type ServerParameters

type ServerParameters struct {
	MaxConnectionIdle      time.Duration `yaml:"maxConnectionIdle"`
	MaxConnectionAge       time.Duration `yaml:"maxConnectionAge"`
	MaxConnectionAgreGrace time.Duration `yaml:"maxConnectionAgreGrace"`
	Time                   time.Duration `yaml:"time"`
	Timeout                time.Duration `yaml:"timeout"`
	Shutdown               time.Duration `yaml:"shutdown"`
}

func (ServerParameters) Object

func (s ServerParameters) Object() keepalive.ServerParameters

type Timeout

type Timeout struct {
	Idle       time.Duration `yaml:"idle"`
	ReadHeader time.Duration `yaml:"readHeader"`
	Read       time.Duration `yaml:"read"`
	Write      time.Duration `yaml:"write"`
	Shutdown   time.Duration `yaml:"shutdown"`
}

Timeout allows to configure different timeout durations.