portmap

package module

v0.0.0-...-e6325c6 Latest Latest Go to latest Published: Jan 2, 2024 License: MIT Imports: 8 Imported by: 1

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

Repository

github.com/jech/portmap

Links

Open Source Insights

README ¶

Map TCP and UDP ports using NAT-PMP or UPNP.  Unlike some other libraries,
guarantee that we don't override other clients' ports, and that the
mappings will expire even if the client crashes.

See portmap-example for an example.

Documentation ¶

Overview ¶

Package portmap implements port mapping using NAT-PMP or uPNP.

Index ¶

Constants
func Map(ctx context.Context, label string, internal uint16, kind int, ...) error
type Status

Constants ¶

View Source

const (
	NATPMP = 1
	UPNP   = 2
	All    = NATPMP | UPNP
)

Variables ¶

This section is empty.

Functions ¶

func Map ¶

func Map(ctx context.Context, label string, internal uint16, kind int, f func(proto string, status Status, err error)) error

Map runs a portmapping loop for both TCP and UDP. The kind parameter indicates the portmapping protocols to attempt.

The label is passed to the UPNP server (it is not used with NAT-PMP) and may be displayed in the router's user interface.

The callback function is called whenever a mapping is established or changes, or when an error occurs; it may be nil.

Types ¶

type Status ¶

type Status struct {
	Internal, External uint16
	Lifetime           time.Duration
}

Status is passed to the callback of Map

Source Files ¶

View all Source files

portmap.go

Directories ¶

Path	Synopsis
portmap-example

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL