fastip

Documentation

Overview

Package fastip implements the algorithm that allows to query multiple resolvers, ping all IP addresses that were returned, and return the fastest one among them.

Index

• Constants
• type Config
• type FastestAddr
  • func New(c *Config) (f *FastestAddr)
  • func NewFastestAddr() (f *FastestAddr)
  • func (f *FastestAddr) ExchangeFastest(req *dns.Msg, ups []upstream.Upstream) (resp *dns.Msg, u upstream.Upstream, err error)

Constants

const DefaultPingWaitTimeout = 1 * time.Second

DefaultPingWaitTimeout is the default period of time for waiting ping operations to finish.

const LogPrefix = "fastip"

LogPrefix is a prefix for logging.

Types

type Config

type Config struct {
	// Logger is used as the base logger for the service.  If nil,
	// [slog.Default] with [LogPrefix] is used.
	Logger *slog.Logger

	// PingWaitTimeout is the timeout for waiting all the resolved addresses to
	// be pinged.  Any ping results received after that moment are cached, but
	// won't be used.  If zero, [DefaultPingWaitTimeout] is used.
	PingWaitTimeout time.Duration
}

Config contains all the fields necessary for proxy configuration.

type FastestAddr

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

FastestAddr provides methods to determine the fastest network addresses.

func New

func New(c *Config) (f *FastestAddr)

New initializes a new instance of *FastestAddr.

func NewFastestAddr

func NewFastestAddr() (f *FastestAddr)

NewFastestAddr initializes a new instance of *FastestAddr.

Deprecated: Use New instead.

func (*FastestAddr) ExchangeFastest

func (f *FastestAddr) ExchangeFastest(
	req *dns.Msg,
	ups []upstream.Upstream,
) (resp *dns.Msg, u upstream.Upstream, err error)

ExchangeFastest queries each specified upstream and returns the response with the fastest IP address. The fastest IP address is considered to be the first one successfully dialed and other addresses are removed from the answer.