reserveport

Documentation

Index

• type PortManager
  • func NewPortManager() (mgr PortManager, err error)
  • func NewPortManagerOrFail(t *testing.T) PortManager
• type ReservedPort

Types

type PortManager

type PortManager interface {
	// ReservePort reserves a new port. The lifecycle of the returned port is transferred to the caller.
	ReservePort() (ReservedPort, error)
	ReservePortOrFail(t *testing.T) ReservedPort
	ReservePortNumber() (uint16, error)
	ReservePortNumberOrFail(t *testing.T) uint16
	// Close shuts down this manager and frees any associated resources.
	Close() error
	CloseSilently()
}

PortManager is responsible for reserving ports for an application.

func NewPortManager

func NewPortManager() (mgr PortManager, err error)

NewPortManager allocates a new PortManager

func NewPortManagerOrFail

func NewPortManagerOrFail(t *testing.T) PortManager

NewPortManagerOrFail calls NewPortManager and fails the test if unsuccessful.

type ReservedPort

type ReservedPort interface {
	// GetPort returns the bound port number.
	GetPort() uint16
	// Close unbinds this port.
	Close() error
	CloseSilently()
}

ReservedPort a port reserved by a PortManager