addr

Documentation

Overview

addr provides functions to retrieve local IP addresses from device interfaces.

Index

• Variables
• func Extract(addr string) (string, error)
• func IPs() []string
• func IsLocal(addr string) bool

Variables

var (
	// ErrIPNotFound no IP address found, and explicit IP not provided.
	ErrIPNotFound = errors.New("no IP address found, and explicit IP not provided")
)

Functions

func Extract

func Extract(addr string) (string, error)

Extract returns a valid IP address. If the address provided is a valid address, it will be returned directly. Otherwise, the available interfaces will be iterated over to find an IP address, preferably private.

func IPs

func IPs() []string

IPs returns all available interface IP addresses.

func IsLocal

func IsLocal(addr string) bool

IsLocal checks whether an IP belongs to one of the device's interfaces.