endpoints

Documentation

Index

• func DetectPublicAddresses(ctx context.Context) ([]netip.Addr, error)
• type DetectOpts
• type PrefixList
  • func Detect(ctx context.Context, opts DetectOpts) (PrefixList, error)
  • func (a PrefixList) AddrPorts(port uint16) []netip.AddrPort
  • func (a PrefixList) AddrStrings() []string
  • func (a PrefixList) Contains(addr netip.Addr) bool
  • func (a PrefixList) FirstPublicAddr() netip.Addr
  • func (a PrefixList) Len() int
  • func (a PrefixList) Less(i, j int) bool
  • func (a PrefixList) PrivateAddrs() []netip.Addr
  • func (a PrefixList) PublicAddrs() []netip.Addr
  • func (a PrefixList) Strings() []string
  • func (a PrefixList) Swap(i, j int)
  • func (a PrefixList) WebmeshMultiaddrs(proto string, port uint16, peerID peer.ID) []ma.Multiaddr

Functions

func DetectPublicAddresses

func DetectPublicAddresses(ctx context.Context) ([]netip.Addr, error)

DetectPublicAddresses detects the public addresses of the machine using the opendns resolver service.

Types

type DetectOpts

type DetectOpts struct {
	// DetectIPv6 enables IPv6 detection.
	DetectIPv6 bool
	// DetectPrivate enables private address detection.
	DetectPrivate bool
	// AllowRemoteDetection enables remote address detection.
	AllowRemoteDetection bool
	// SkipInterfaces contains a list of interfaces to skip.
	SkipInterfaces []string
}

DetectOpts contains options for endpoint detection.

type PrefixList

type PrefixList []netip.Prefix

PrefixList wraps a list of network prefixes with added functionality.

func Detect

func Detect(ctx context.Context, opts DetectOpts) (PrefixList, error)

Detect detects endpoints for this machine.

func (PrefixList) AddrPorts

func (a PrefixList) AddrPorts(port uint16) []netip.AddrPort

func (PrefixList) AddrStrings

func (a PrefixList) AddrStrings() []string

func (PrefixList) Contains

func (a PrefixList) Contains(addr netip.Addr) bool

func (PrefixList) FirstPublicAddr

func (a PrefixList) FirstPublicAddr() netip.Addr

func (PrefixList) Len

func (a PrefixList) Len() int

func (PrefixList) Less

func (a PrefixList) Less(i, j int) bool

Sort by Public addresses first. Then IPv4 addresses and finally IPv6 addresses.

func (PrefixList) PrivateAddrs

func (a PrefixList) PrivateAddrs() []netip.Addr

func (PrefixList) PublicAddrs

func (a PrefixList) PublicAddrs() []netip.Addr

func (PrefixList) Strings

func (a PrefixList) Strings() []string

func (PrefixList) Swap

func (a PrefixList) Swap(i, j int)

func (PrefixList) WebmeshMultiaddrs

func (a PrefixList) WebmeshMultiaddrs(proto string, port uint16, peerID peer.ID) []ma.Multiaddr