portallocator

Documentation

Index

• func SetupRuntimePortAllocator(client client.Client, pr *net.PortRange, ...)
• func SetupRuntimePortAllocatorWithType(client client.Client, pr *net.PortRange, allocatePolicy AllocatePolicy, ...)
• type AllocatePolicy
• type BatchAllocatorInterface
• type BitMapAllocator
  • func (b *BitMapAllocator) Allocate(port int) error
  • func (b *BitMapAllocator) AllocateBatch(portNum int) (ports []int, err error)
  • func (b *BitMapAllocator) Release(port int) error
• type RandomAllocator
  • func (r *RandomAllocator) Allocate(port int) error
  • func (r *RandomAllocator) AllocateBatch(portNum int) (ports []int, err error)
  • func (r *RandomAllocator) Release(i int) error
• type RuntimePortAllocator
  • func GetRuntimePortAllocator() (*RuntimePortAllocator, error)
  • func (alloc *RuntimePortAllocator) GetAvailablePorts(portNum int) (ports []int, err error)
  • func (alloc *RuntimePortAllocator) ReleaseReservedPorts(ports []int)

Functions

func SetupRuntimePortAllocator

func SetupRuntimePortAllocator(client client.Client, pr *net.PortRange, getReservedPorts func(client client.Client) (ports []int, err error))

SetupRuntimePortAllocator instantiates the global singleton rpa, use BitMap port allocating policy

func SetupRuntimePortAllocatorWithType

func SetupRuntimePortAllocatorWithType(client client.Client, pr *net.PortRange, allocatePolicy AllocatePolicy, getReservedPorts func(client client.Client) (ports []int, err error))

SetupRuntimePortAllocatorWithType instantiates the global singleton rpa with specified port allocating policy

Types

type AllocatePolicy

type AllocatePolicy string

const (
	Random AllocatePolicy = "random"
	BitMap AllocatePolicy = "bitmap"
)

type BatchAllocatorInterface

type BatchAllocatorInterface interface {
	Allocate(int) error

	Release(int) error

	AllocateBatch(portNum int) ([]int, error)
	// contains filtered or unexported methods
}

type BitMapAllocator

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

func (*BitMapAllocator) Allocate

func (b *BitMapAllocator) Allocate(port int) error

func (*BitMapAllocator) AllocateBatch

func (b *BitMapAllocator) AllocateBatch(portNum int) (ports []int, err error)

func (*BitMapAllocator) Release

func (b *BitMapAllocator) Release(port int) error

type RandomAllocator

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

func (*RandomAllocator) Allocate

func (r *RandomAllocator) Allocate(port int) error

func (*RandomAllocator) AllocateBatch

func (r *RandomAllocator) AllocateBatch(portNum int) (ports []int, err error)

func (*RandomAllocator) Release

func (r *RandomAllocator) Release(i int) error

type RuntimePortAllocator

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

RuntimePortAllocator is an allocator resonsible for maintaining port usage information given a user-defined port range. It allocates and releases ports when a port is requested or reclaimed by a runtime.

func GetRuntimePortAllocator

func GetRuntimePortAllocator() (*RuntimePortAllocator, error)

GetRuntimePortAllocator restore the port allocator and gets the global singleton. This should be the only way others access the RuntimePortAllocator and it must be called after SetupRuntimePortAllocator

func (*RuntimePortAllocator) GetAvailablePorts

func (alloc *RuntimePortAllocator) GetAvailablePorts(portNum int) (ports []int, err error)

GetAvailablePorts requests portNum ports from the port allocator. It returns an int array with allocated ports in it.

func (*RuntimePortAllocator) ReleaseReservedPorts

func (alloc *RuntimePortAllocator) ReleaseReservedPorts(ports []int)

ReleaseReservedPorts releases all the ports in the given int array.