portallocator

Documentation

Index

• Constants
• Variables
• func PortRange() (int, int)
• type ErrPortAlreadyAllocated
  • func NewErrPortAlreadyAllocated(ip string, port int) ErrPortAlreadyAllocated
  • func (e ErrPortAlreadyAllocated) Error() string
  • func (e ErrPortAlreadyAllocated) IP() string
  • func (e ErrPortAlreadyAllocated) IPPort() string
  • func (e ErrPortAlreadyAllocated) Port() int
• type PortAllocator
  • func New() *PortAllocator
  • func (p *PortAllocator) ReleaseAll() error
  • func (p *PortAllocator) ReleasePort(ip net.IP, proto string, port int) error
  • func (p *PortAllocator) RequestPort(ip net.IP, proto string, port int) (int, error)

Constants

const (
	DefaultPortRangeStart = 49153
	DefaultPortRangeEnd   = 65535
)

Variables

var (
	ErrAllPortsAllocated = errors.New("all ports are allocated")
	ErrUnknownProtocol   = errors.New("unknown protocol")
)

var (
	DefaultPortAllocator = New()
	RequestPort          = DefaultPortAllocator.RequestPort
	ReleasePort          = DefaultPortAllocator.ReleasePort
	ReleaseAll           = DefaultPortAllocator.ReleaseAll
)

Functions

func PortRange

func PortRange() (int, int)

Types

type ErrPortAlreadyAllocated

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

func NewErrPortAlreadyAllocated

func NewErrPortAlreadyAllocated(ip string, port int) ErrPortAlreadyAllocated

func (ErrPortAlreadyAllocated) Error

func (e ErrPortAlreadyAllocated) Error() string

func (ErrPortAlreadyAllocated) IP

func (e ErrPortAlreadyAllocated) IP() string

func (ErrPortAlreadyAllocated) IPPort

func (e ErrPortAlreadyAllocated) IPPort() string

func (ErrPortAlreadyAllocated) Port

func (e ErrPortAlreadyAllocated) Port() int

type PortAllocator

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

func New

func New() *PortAllocator

func (*PortAllocator) ReleaseAll

func (p *PortAllocator) ReleaseAll() error

ReleaseAll releases all ports for all ips.

func (*PortAllocator) ReleasePort

func (p *PortAllocator) ReleasePort(ip net.IP, proto string, port int) error

ReleasePort releases port from global ports pool for specified ip and proto.

func (*PortAllocator) RequestPort

func (p *PortAllocator) RequestPort(ip net.IP, proto string, port int) (int, error)

RequestPort requests new port from global ports pool for specified ip and proto. If port is 0 it returns first free port. Otherwise it cheks port availability in pool and return that port or error if port is already busy.