portlist

package

v0.0.0-...-ded95ce Latest Latest Go to latest Published: Dec 14, 2022 License: BSD-3-Clause Imports: 22 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Rendered for

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

This section is empty.

This section is empty.

This section is empty.

type List []Port

List is a list of Ports.

func (pl List) String() string

type Poller struct {
	// contains filtered or unexported fields
}

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

func NewPoller() (*Poller, error)

NewPoller returns a new portlist Poller. It returns an error if the portlist couldn't be obtained.

func (p *Poller) Close() error

Close closes the Poller. Run will return with a nil error.

func (p *Poller) Run(ctx context.Context) error

Run runs the Poller periodically until either the context is done, or the Close is called.

Run may only be called once.

func (p *Poller) Updates() <-chan List

Updates return the channel that receives port list updates.

The channel is closed when the Poller is closed.

type Port struct {
	Proto   string // "tcp" or "udp"
	Port    uint16 // port number
	Process string // optional process name, if found
}

Port is a listening port on the machine.