portlist

Documentation

Overview

The portlist package contains code that checks what ports are open and listening on the current machine.

Index

• func PollInterval() time.Duration
• type List
  • func (pl List) String() string
• type Poller
  • func (p *Poller) Close() error
  • func (p *Poller) Poll() (ports []Port, changed bool, err error)
• type Port

Functions

func PollInterval

func PollInterval() time.Duration

PollInterval is the recommended OS-specific interval to wait between *Poller.Poll method calls.

Types

type List

type List []Port

List is a list of Ports.

func (List) String

func (pl List) String() string

type Poller

type Poller struct {
	// IncludeLocalhost controls whether services bound to localhost are included.
	//
	// This field should only be changed before calling Run.
	IncludeLocalhost bool
	// contains filtered or unexported fields
}

Poller scans the systems for listening ports periodically and sends the results to C.

func (*Poller) Close

func (p *Poller) Close() error

Close closes the Poller.

func (*Poller) Poll

func (p *Poller) Poll() (ports []Port, changed bool, err error)

Poll returns the list of listening ports, if changed from a previous call as indicated by the changed result.

type Port

type Port struct {
	Proto   string // "tcp" or "udp"
	Port    uint16 // port number
	Process string // optional process name, if found (requires suitable permissions)
	Pid     int    // process ID, if known (requires suitable permissions)
}

Port is a listening port on the machine.