endpoints

package

v0.17.1 Latest Latest Go to latest Published: Nov 16, 2023 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/webmeshproj/webmesh

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

func DetectPublicAddresses(ctx context.Context) ([]netip.Addr, error)
type DetectOpts
type PrefixList
- func Detect(ctx context.Context, opts DetectOpts) (PrefixList, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

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 ¶ added in v0.10.1

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 ¶ added in v0.12.0

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

func (PrefixList) PublicAddrs ¶ added in v0.12.0

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL