freeport

Documentation

Index

• type Port
  • func GetFreePort(address string, protocol Protocol) (*Port, error)
  • func GetFreePortInRange(address string, protocol Protocol, minPort, maxPort int) (*Port, error)
  • func GetFreePortOnInterface(interfaceName string, protocol Protocol) (*Port, error)
  • func GetFreePorts(address string, protocol Protocol, count int) ([]*Port, error)
  • func GetFreeTCPPort(address string) (*Port, error)
  • func GetFreeUDPPort(address string) (*Port, error)
  • func GetPort(protocol Protocol, address string, port int) (*Port, error)
  • func MustGetFreeTCPPort(address string) *Port
  • func MustGetFreeUDPPort(address string) *Port
• type Protocol

Types

type Port

type Port struct {
	Address  string
	Port     int
	Protocol Protocol
}

Port obtained from the kernel

func GetFreePort

func GetFreePort(address string, protocol Protocol) (*Port, error)

GetFreePort from ip address and protocol

func GetFreePortInRange

func GetFreePortInRange(address string, protocol Protocol, minPort, maxPort int) (*Port, error)

GetFreePortInRange for protocol within a port range

func GetFreePortOnInterface

func GetFreePortOnInterface(interfaceName string, protocol Protocol) (*Port, error)

GetFreePortOnInterface by name and protocol

func GetFreePorts

func GetFreePorts(address string, protocol Protocol, count int) ([]*Port, error)

GetFreePorts collects "count" free ports of specific protocol

func GetFreeTCPPort

func GetFreeTCPPort(address string) (*Port, error)

GetFreeTCPPort gets a free tcp port on address

func GetFreeUDPPort

func GetFreeUDPPort(address string) (*Port, error)

GetFreeUDPPort gets a free udp port on address

func GetPort

func GetPort(protocol Protocol, address string, port int) (*Port, error)

GetPort for protocol is the specific port is free

func MustGetFreeTCPPort

func MustGetFreeTCPPort(address string) *Port

MustGetFreeTCPPort get a free tcp port for address or panic

func MustGetFreeUDPPort

func MustGetFreeUDPPort(address string) *Port

MustGetFreeUDPPort get a free udp port for address or panic

type Protocol

type Protocol uint8

Protocol represents the supported protocol type

const (
	TCP Protocol = iota
	UDP
)