config

Documentation

Overview

Package config contains the configuration of sciond.

Index

• Variables
• 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
• type SDConfig
  • func (cfg *SDConfig) ConfigName() string
  • func (cfg *SDConfig) CreateSocketDirs() error
  • func (cfg *SDConfig) InitDefaults()
  • func (cfg *SDConfig) Sample(dst io.Writer, path config.Path, ctx config.CtxMap)
  • func (cfg *SDConfig) Validate() error

Variables

var (
	DefaultQueryInterval = 5 * time.Minute
)

Types

type Config

type Config struct {
	General   env.General
	Features  env.Features
	Logging   env.Logging
	Metrics   env.Metrics
	Tracing   env.Tracing
	QUIC      env.QUIC `toml:"quic"`
	TrustDB   truststorage.TrustDBConf
	Discovery idiscovery.Config
	SD        SDConfig
}

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

type SDConfig

type SDConfig struct {
	// Address to listen on via the reliable socket protocol. If empty,
	// a reliable socket server on the default socket is started.
	Reliable string
	// Address to listen on for normal unixgram messages. If empty, a
	// unixgram server on the default socket is started.
	Unix string
	// Socket files (both Reliable and Unix) permissions when created; read from octal (e.g. 0755).
	SocketFileMode util.FileMode
	// If set to True, the socket is removed before being created
	DeleteSocket bool
	// Public is the local address to listen on for SCION messages (if Bind is
	// not set), and to send out messages to other nodes.
	Public *snet.Addr
	// If set, Bind is the preferred local address to listen on for SCION
	// messages.
	Bind *snet.Addr
	// PathDB contains the configuration for the PathDB connection.
	PathDB pathstorage.PathDBConf
	// RevCache contains the configuration for the RevCache connection.
	RevCache pathstorage.RevCacheConf
	// QueryInterval specifies after how much time segments
	// for a destination should be refetched.
	QueryInterval util.DurWrap
}

func (*SDConfig) ConfigName

func (cfg *SDConfig) ConfigName() string

func (*SDConfig) CreateSocketDirs

func (cfg *SDConfig) CreateSocketDirs() error

func (*SDConfig) InitDefaults

func (cfg *SDConfig) InitDefaults()

func (*SDConfig) Sample

func (cfg *SDConfig) Sample(dst io.Writer, path config.Path, ctx config.CtxMap)

func (*SDConfig) Validate

func (cfg *SDConfig) Validate() error