freeport

Documentation

Index

• func AllocateTCPPort() (uint16, io.Closer, error)
• func MustConsume(port uint16, lis io.Closer, err error) int

Functions

func AllocateTCPPort

func AllocateTCPPort() (uint16, io.Closer, error)

AllocateTCPPort allocates a TCP port on the looopback address, and starts a temporary listener on it. That listener is returned to the caller alongside with the allocated port number. The listener must be closed right before the port is used by the caller. This naturally still leaves a race condition window where that port number might be snatched up by some other process, but there doesn't seem to be a better way to do this.

func MustConsume

func MustConsume(port uint16, lis io.Closer, err error) int

MustConsume takes the result of AllocateTCPPort, closes the listener and returns the allocated port. If anything goes wrong (port could not be allocated or closed) it will panic.