package portmapper

Import Path
	github.com/tmc/go-iroh/internal/portmapper (on go.dev)

Dependency Relation
	imports 7 packages, and imported by one package

Involved Source Files

	  d natpmp.go
		Package portmapper is a minimal NAT-PMP (RFC 6886) client for requesting a
		UDP port mapping from a home gateway.
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type Mapping (struct)
		Mapping is a UDP port mapping returned by a gateway.

		Fields (total 2)
			ExternalAddr netip.AddrPort
			Lifetime time.Duration
		As Outputs Of (at least one exported)
			func NATPMPClient.MapUDP(ctx context.Context, internalPort uint16, suggestedExternalPort uint16, lifetime time.Duration) (Mapping, error)

	 type NATPMPClient (struct)
		NATPMPClient is a minimal NAT-PMP client.

		Fields (total 3)
			Gateway netip.Addr
			Port uint16
			Timeout time.Duration
		Methods (total 2)
			( NATPMPClient) ExternalIPv4(ctx context.Context) (netip.Addr, error)
				ExternalIPv4 returns the public IPv4 address reported by the gateway.

			( NATPMPClient) MapUDP(ctx context.Context, internalPort uint16, suggestedExternalPort uint16, lifetime time.Duration) (Mapping, error)
				MapUDP maps internalPort through the NAT-PMP gateway, requesting the given
				lifetime. A lifetime of 0 deletes the mapping (RFC 6886 §3.4): the gateway
				removes any mapping for internalPort and returns a zero Mapping.

The pages are generated with Golds v0.8.4. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.