net

Documentation

Index

• type ErrPortBusy
  • func (err *ErrPortBusy) Error() string
• type ErrPortFileLocked
  • func (port ErrPortFileLocked) Error() string
• type ListenRangeConfig
  • func (lc ListenRangeConfig) Listen(ctx context.Context) (*Listener, error)
• type Listener
  • func (l *Listener) Close() error

Types

type ErrPortBusy

type ErrPortBusy struct {
	Port int
	Err  error
}

func (*ErrPortBusy) Error

func (err *ErrPortBusy) Error() string

type ErrPortFileLocked

type ErrPortFileLocked int

func (ErrPortFileLocked) Error

func (port ErrPortFileLocked) Error() string

type ListenRangeConfig

type ListenRangeConfig struct {
	// like "tcp" or "udp". defaults to "tcp".
	Network  string
	Addr     string
	Min, Max int
	net.ListenConfig
}

ListenRangeConfig contains options for listening to a free address [Min,Max) range. ListenRangeConfig wraps a net.ListenConfig.

func (ListenRangeConfig) Listen

func (lc ListenRangeConfig) Listen(ctx context.Context) (*Listener, error)

Listen tries to Listen to a random open TCP port in the [min, max) range until ctx is cancelled. Listen uses net.ListenConfig.Listen internally.

type Listener

type Listener struct {
	// Listener can be closed but Port will be file locked by packer until
	// Close is called.
	net.Listener
	Port    int
	Address string
	// contains filtered or unexported fields
}

Listener wraps a net.Lister with some magic packer capabilies. For example until you call Listener.Close, any call to ListenRangeConfig.Listen cannot bind to Port. Packer tries tells moving parts which port they can use, but often the port has to be released before a 3rd party is started, like a VNC server.

func (*Listener) Close

func (l *Listener) Close() error