config

Documentation

Overview

Package config contains the configuration of the SCION dispatcher.

Index

• type Config
  • func (cfg *Config) ConfigName() string
  • func (cfg *Config) InitDefaults()
  • func (cfg *Config) Sample(dst io.Writer, path config.Path, _ config.CtxMap)
  • func (cfg *Config) Validate() error

Types

type Config

type Config struct {
	Features   env.Features
	Logging    env.Logging
	Metrics    env.Metrics
	Dispatcher struct {
		// ID of the Dispatcher (required)
		ID string
		// ApplicationSocket is the local API socket (default /run/shm/dispatcher/default.sock)
		ApplicationSocket string
		// Socket file permissions when created; read from octal. (default 0770)
		SocketFileMode util.FileMode
		// OverlayPort is the native port opened by the dispatcher (default 30041)
		OverlayPort int
		// PerfData starts the pprof HTTP server on the specified address. If not set,
		// the server is not started.
		PerfData string
		// DeleteSocket specifies whether the dispatcher should delete the
		// socket file prior to attempting to create a new one.
		DeleteSocket bool
	}
}

func (*Config) ConfigName

func (cfg *Config) ConfigName() string

func (*Config) InitDefaults

func (cfg *Config) InitDefaults()

func (*Config) Sample

func (cfg *Config) Sample(dst io.Writer, path config.Path, _ config.CtxMap)

func (*Config) Validate

func (cfg *Config) Validate() error