netkit

Documentation

Index

• func FreePort(n Network) (int, error)
• func GetFreePort() (int, error)
• func IsPortFree(network Network, port int) (ok bool, returnErr error)
• type Network
  • func (n Network) String() string

Functions

func FreePort

func FreePort(n Network) (int, error)

FreePort attempts to request from the OS an available local free port for a given network type.

Be careful, as it might take a bit time to have the port fully released before you can use it to initiate a new connection

func GetFreePort

func GetFreePort() (int, error)

GetFreePort returns a

Deprecated: use netkit.FreePort("tcp") instead

func IsPortFree

func IsPortFree(network Network, port int) (ok bool, returnErr error)

IsPortFree checks if a given TCP port is free to bind to. It takes into account specifics of

MacOS behavior where multiple IP versions (IPv4 and IPv6) may be bound to the same port, which can lead to false positives in port availability checking. IsPortFree able to work this around by checking both ip versions for the port, to give a unified behaviour across different platforms.

If you wish to check both TCP and UDP networks, then give a zero value to the Network argument.

Types

type Network

type Network string

const (
	TCP  Network = "tcp"
	TCP4 Network = "tcp4"
	TCP6 Network = "tcp6"
)

const (
	UDP  Network = "udp"
	UDP4 Network = "udp4"
	UDP6 Network = "udp6"
)

func (Network) String

func (n Network) String() string