server

Documentation

Index

• Variables
• type Dialer
• type Logger
• type Middleware
• type Server
  • func New(settings Settings) (server *Server, err error)
  • func (s *Server) ListeningAddress() (address netip.AddrPort, err error)
  • func (s *Server) Start(ctx context.Context) (runError <-chan error, startErr error)
  • func (s *Server) Stop() (err error)
  • func (s *Server) String() string
• type Settings
  • func (s *Settings) SetDefaults()
  • func (s *Settings) String() string
  • func (s *Settings) ToLinesNode() (node *gotree.Node)
  • func (s Settings) Validate() (err error)
• type Warner

Variables

var (
	ErrServerNotRunning      = errors.New("server not running")
	ErrListeningUDPTCPDiffer = errors.New("udp and tcp listening addresses differ")
)

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

Types

type Dialer

type Dialer interface {
	Dial(ctx context.Context, network, _ string) (conn net.Conn, err error)
	// String returns the connection type the dialer will use, for example
	// "dns over tls".
	String() string
}

type Logger

type Logger interface {
	Info(s string)
	Warner
}

type Middleware

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

type Server

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

func New

func New(settings Settings) (server *Server, err error)

func (*Server) ListeningAddress

func (s *Server) ListeningAddress() (address netip.AddrPort, err error)

func (*Server) Start

func (s *Server) Start(ctx context.Context) (runError <-chan error, startErr error)

func (*Server) Stop

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

func (*Server) String

func (s *Server) String() string

type Settings

type Settings struct {
	// ListeningAddress is the server listening address, and defaults
	// to ":53".
	ListeningAddress *string
	// Dialer is used to establish connections with upstream resolvers
	// and must be set.
	Dialer Dialer
	// 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 (*Settings) SetDefaults

func (s *Settings) SetDefaults()

func (*Settings) String

func (s *Settings) String() string

func (*Settings) ToLinesNode

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

func (Settings) Validate

func (s Settings) Validate() (err error)

type Warner

type Warner interface {
	Warn(s string)
}