networkutils

Documentation

Index

• func GetLocalIP() (net.IP, error)
• func IsIPInUse(client NetClient, ip string) bool
• func IsPortInUse(client NetClient, host string, port string) bool
• func IsPortValid(port string) bool
• func ValidateIP(ip string) error
• type DefaultNetClient
  • func (n *DefaultNetClient) DialTimeout(network, address string, timeout time.Duration) (net.Conn, error)
• type IPGenerator
  • func NewIPGenerator(netClient NetClient) IPGenerator
  • func (ipgen IPGenerator) GenerateUniqueIP(cidrBlock string) (string, error)
• type IPPool
  • func NewIPPool() IPPool
  • func NewIPPoolFromEnv(ipPoolEnvVar string) (IPPool, error)
  • func NewIPPoolFromString(fromString string) IPPool
  • func (ipPool *IPPool) AddIP(ip string)
  • func (ipPool *IPPool) IsEmpty() bool
  • func (ipPool *IPPool) PopIP() (string, error)
  • func (ipPool *IPPool) ToEnvVar(envVarName string) error
  • func (ipPool *IPPool) ToString() string
• type NetClient

Functions

func GetLocalIP

func GetLocalIP() (net.IP, error)

func IsIPInUse

func IsIPInUse(client NetClient, ip string) bool

IsIPInUse performs a best effort check to see if an IP address is in use. It is not completely reliable as testing if an IP is in use is inherently difficult, particularly with non-trivial network topologies.

func IsPortInUse

func IsPortInUse(client NetClient, host string, port string) bool

func IsPortValid

func IsPortValid(port string) bool

func ValidateIP

func ValidateIP(ip string) error

Types

type DefaultNetClient

type DefaultNetClient struct{}

func (*DefaultNetClient) DialTimeout

func (n *DefaultNetClient) DialTimeout(network, address string, timeout time.Duration) (net.Conn, error)

type IPGenerator

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

func NewIPGenerator

func NewIPGenerator(netClient NetClient) IPGenerator

func (IPGenerator) GenerateUniqueIP

func (ipgen IPGenerator) GenerateUniqueIP(cidrBlock string) (string, error)

type IPPool

type IPPool []string

func NewIPPool

func NewIPPool() IPPool

func NewIPPoolFromEnv

func NewIPPoolFromEnv(ipPoolEnvVar string) (IPPool, error)

func NewIPPoolFromString

func NewIPPoolFromString(fromString string) IPPool

func (*IPPool) AddIP

func (ipPool *IPPool) AddIP(ip string)

func (*IPPool) IsEmpty

func (ipPool *IPPool) IsEmpty() bool

func (*IPPool) PopIP

func (ipPool *IPPool) PopIP() (string, error)

func (*IPPool) ToEnvVar

func (ipPool *IPPool) ToEnvVar(envVarName string) error

func (*IPPool) ToString

func (ipPool *IPPool) ToString() string

type NetClient

type NetClient interface {
	DialTimeout(network, address string, timeout time.Duration) (net.Conn, error)
}