package nat

Import Path
	github.com/libp2p/go-libp2p/p2p/net/nat/internal/nat (on go.dev)

Dependency Relation
	imports 16 packages, and imported by one package

Involved Source Files

	  d nat.go
		Package nat implements NAT handling facilities

	    natpmp.go
	    upnp.go
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type ErrNoNATFound (struct)

		Fields (only one)
			Errs []error
		Methods (total 2)
			( ErrNoNATFound) Error() string
			( ErrNoNATFound) Unwrap() []error
		Implements (at least one exported)
			 ErrNoNATFound : error

	 type NAT (interface)
		protocol is either "udp" or "tcp"

		Methods (total 6)
			( NAT) AddPortMapping(ctx context.Context, protocol string, internalPort int, description string, timeout time.Duration) (mappedExternalPort int, err error)
				AddPortMapping maps a port on the local host to an external port.

			( NAT) DeletePortMapping(ctx context.Context, protocol string, internalPort int) (err error)
				DeletePortMapping removes a port mapping.

			( NAT) GetDeviceAddress() (addr net.IP, err error)
				GetDeviceAddress returns the internal address of the gateway device.

			( NAT) GetExternalAddress() (addr net.IP, err error)
				GetExternalAddress returns the external address of the gateway device.

			( NAT) GetInternalAddress() (addr net.IP, err error)
				GetInternalAddress returns the address of the local host.

			( NAT) Type() string
				Type returns the kind of NAT port mapping service that is used

		As Outputs Of (at least one exported)
			func DiscoverGateway(ctx context.Context) (NAT, error)


Package-Level Functions (only one)

	 func DiscoverGateway(ctx context.Context) (NAT, error)
		DiscoverGateway attempts to find a gateway device.


Package-Level Variables (total 2)

	  var ErrNoExternalAddress error
	  var ErrNoInternalAddress error

The pages are generated with Golds v0.8.2. (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.