randomports

Documentation

Overview

Package randomports provides helpers to get random, free port numbers for testing listener use cases.

Index

• func Reserve(p Port) bool
• func Two() (Port, Port, error)
• type Port
  • func One() (Port, error)
  • func RandomPorts(n int) ([]Port, error)
  • func (p Port) Int() int
  • func (p *Port) Must() *Port
  • func (p Port) String() string
  • func (p Port) Uint() uint
  • func (p Port) Uint16() uint16

Functions

func Reserve

func Reserve(p Port) bool

Reserve puts the port into a shared cache. When the port exist, false is returned (as in it could not reserve the port for you to vend).

func Two

func Two() (Port, Port, error)

Two provides a set of ports. For convenience.

Types

type Port

type Port uint16

Port holds a port number value. This type provides a convenient handle on that port number across a few different use cases.

func One

func One() (Port, error)

One provides a single port. For convenience.

func RandomPorts

func RandomPorts(n int) ([]Port, error)

RandomPorts returns a list of port numbers that are safe-to-assume to be free. An internal list is used track vended ports to avoid concurrent users from seeing conflicting ports.

func (Port) Int

func (p Port) Int() int

Int returns the port as an int.

func (*Port) Must

func (p *Port) Must() *Port

Must is a builder style conditional that can be used to ensure (by panic) that a port number is given (ie: not 0).

func (Port) String

func (p Port) String() string

String prints the port number as a string.

func (Port) Uint

func (p Port) Uint() uint

Uint returns the port as an uint.

func (Port) Uint16

func (p Port) Uint16() uint16

Uint16 returns the port as an uint16.