freeport

README

freeport is a copy of the freeport package found in github.com/hashicorp/consul/sdk/freeport with modifications to remove dependencies on other consul/sdk packages.

Documentation

Overview

Package freeport provides a helper for allocating free ports across multiple processes on the same machine.

Index

• func Free(n int) (ports []int, err error)
• func Get(n int) (ports []int)
• func GetT(t testing.T, n int) (ports []int)
• func MustTake(n int) (ports []int)
• func Return(ports []int)
• func Take(n int) (ports []int, err error)

Functions

func Free

func Free(n int) (ports []int, err error)

Deprecated: Please use Take/Return calls instead.

func Get

func Get(n int) (ports []int)

Deprecated: Please use Take/Return calls instead.

func GetT

func GetT(t testing.T, n int) (ports []int)

Deprecated: Please use Take/Return calls instead.

func MustTake

func MustTake(n int) (ports []int)

MustTake is the same as Take except it panics on error.

func Return

func Return(ports []int)

Return returns a block of ports back to the general pool. These ports should have been returned from a call to Take().

func Take

func Take(n int) (ports []int, err error)

Take returns a list of free ports from the allocated port block. It is safe to call this method concurrently. Ports have been tested to be available on 127.0.0.1 TCP but there is no guarantee that they will remain free in the future.