netutil

Documentation

Overview

Utilities for working with networks and network accessories.

Index

• Variables
• func DefaultGateway() (net.IP, error)
• func EphemeralPort() (int, error)
• func ExpandPort(address string) string
• func HasRoutableIP(network string, ifi *net.Interface) (net.IP, bool)
• func IsMulticastCapable(network string, ifi *net.Interface) (net.IP, bool)
• func IsRoutableIP(network string, ip net.IP) net.IP
• func RoutedInterface(network string, flags net.Flags) *net.Interface
• func WaitForOpen(network string, address string, totaltime time.Duration, ...) error
• type IPAddress
  • func DefaultAddress() *IPAddress
  • func RoutableAddresses() ([]*IPAddress, error)

Variables

var DefaultWaitForOpenConnectionTimeout = 5 * time.Second

var WaitForOpenCheckInterval = time.Second

Functions

func DefaultGateway

func DefaultGateway() (net.IP, error)

Retrieves the default gateway interface.

func EphemeralPort

func EphemeralPort() (int, error)

Retrieve an open ephemeral port.

func ExpandPort

func ExpandPort(address string) string

Takes an address in the form of "host:port", looks for port zero (e.g: ":0"), and gets an ephemeral local port and returns that address (e.g.: ":41327").

func HasRoutableIP

func HasRoutableIP(network string, ifi *net.Interface) (net.IP, bool)

Returns the first routable address on the given interface.

func IsMulticastCapable

func IsMulticastCapable(network string, ifi *net.Interface) (net.IP, bool)

IsMulticastCapable reports whether ifi is an IP multicast-capable network interface. Network must be "ip", "ip4" or "ip6".

func IsRoutableIP

func IsRoutableIP(network string, ip net.IP) net.IP

Returns true when the given address is unicast routable beyond the current machine.

func RoutedInterface

func RoutedInterface(network string, flags net.Flags) *net.Interface

RoutedInterface returns a network interface that can route IP traffic and satisfies flags. It returns nil when an appropriate network interface is not found. Network must be "ip", "ip4" or "ip6".

func WaitForOpen

func WaitForOpen(network string, address string, totaltime time.Duration, timeouts ...time.Duration) error

Types

type IPAddress

type IPAddress struct {
	IP        net.IP
	Mask      net.IPMask
	Interface net.Interface
	Gateway   net.IP
}

func DefaultAddress

func DefaultAddress() *IPAddress

Retrieves the first routable IP address on any interface that falls inside of the system's default gateway network. Will return nil if no IP could be found.

func RoutableAddresses

func RoutableAddresses() ([]*IPAddress, error)

Return a list of routable IP addresses, along with their associated gateways and interfaces.