dot

Documentation

Index

• Variables
• func NewResolver(settings ResolverSettings) (resolver *net.Resolver, err error)
• type Logger
• type Metrics
• type Middleware
• type ResolverSettings
  • func (s *ResolverSettings) SetDefaults()
  • func (s *ResolverSettings) String() string
  • func (s *ResolverSettings) ToLinesNode() (node *gotree.Node)
  • func (s ResolverSettings) Validate() (err error)
• type Server
  • func NewServer(settings ServerSettings) (server *Server, err error)
  • func (s *Server) ListeningAddress() (address net.Addr, err error)
  • func (s *Server) Start() (runError <-chan error, startErr error)
  • func (s *Server) Stop() (err error)
  • func (s *Server) String() string
• type ServerSettings
  • func (s *ServerSettings) SetDefaults()
  • func (s *ServerSettings) String() string
  • func (s *ServerSettings) ToLinesNode() (node *gotree.Node)
  • func (s ServerSettings) Validate() (err error)
• type Warner

Variables

var (
	ErrListeningAddressNotValid = errors.New("listening address is not valid")
)

var (
	ErrServerNotRunning = errors.New("server not running")
)

var (
	ErrUpstreamResolversNotSet = errors.New("upstream resolvers not set")
)

Functions

func NewResolver

func NewResolver(settings ResolverSettings) (
	resolver *net.Resolver, err error)

NewResolver creates a DNS over TLS resolver.

Types

type Logger

type Logger interface {
	Debug(s string)
	Info(s string)
	Warner
	Error(s string)
}

type Metrics

type Metrics interface {
	DoTDialInc(provider, address, outcome string)
	DNSDialInc(address, outcome string)
}

type Middleware

type Middleware interface {
	String() string
	Wrap(next dns.Handler) dns.Handler
	Stop() (err error)
}

type ResolverSettings

type ResolverSettings struct {
	// UpstreamResolvers is a list of DNS over TLS upstream resolvers
	// to use.
	UpstreamResolvers []provider.Provider
	// Timeout is the maximum duration to wait for a response from
	// upstream DNS over TLS servers. If left unset, it defaults to
	// 5 seconds.
	Timeout time.Duration
	// IPVersion defines the only IP version to use to connect to
	// upstream DNS over TLS servers. If left unset, it defaults to
	// "ipv4".
	IPVersion string
	// Warner is the warning logger to log dial errors.
	// It defaults to a No-Op warner implementation.
	Warner Warner
	// Metrics is the metrics interface to record metric data.
	// It defaults to a No-Op metrics implementation.
	Metrics Metrics
}

func (*ResolverSettings) SetDefaults

func (s *ResolverSettings) SetDefaults()

func (*ResolverSettings) String

func (s *ResolverSettings) String() string

func (*ResolverSettings) ToLinesNode

func (s *ResolverSettings) ToLinesNode() (node *gotree.Node)

func (ResolverSettings) Validate

func (s ResolverSettings) Validate() (err error)

type Server

type Server struct {
	// contains filtered or unexported fields
}

func NewServer

func NewServer(settings ServerSettings) (server *Server, err error)

func (*Server) ListeningAddress

func (s *Server) ListeningAddress() (address net.Addr, err error)

func (*Server) Start

func (s *Server) Start() (runError <-chan error, startErr error)

func (*Server) Stop

func (s *Server) Stop() (err error)

func (*Server) String

func (s *Server) String() string

type ServerSettings

type ServerSettings struct {
	Resolver         ResolverSettings
	ListeningAddress *string
	// Middlewares is a list of middlewares to use.
	// The first one is the first wrapper, and the last one
	// is the last wrapper of the handlers in the chain.
	Middlewares []Middleware
	// Logger is the logger to log information.
	// It defaults to a No-Op logger implementation.
	Logger Logger
}

func (*ServerSettings) SetDefaults

func (s *ServerSettings) SetDefaults()

func (*ServerSettings) String

func (s *ServerSettings) String() string

func (*ServerSettings) ToLinesNode

func (s *ServerSettings) ToLinesNode() (node *gotree.Node)

func (ServerSettings) Validate

func (s ServerSettings) Validate() (err error)

type Warner

type Warner interface {
	Warn(s string)
}