nat

README

go-nat

Forked from: fd/go-nat.

---

The last gx published version of this module was: 1.0.3: QmdwkZHamNNrj7k3G29rnurmW3mFzsDhnyXppNcgYsiBVz

Documentation

Overview

Package nat implements NAT handling facilities

Index

• Variables
• func DiscoverNATs(ctx context.Context) <-chan NAT
• type NAT
  • func DiscoverGateway() (NAT, error)

Variables

var ErrNoExternalAddress = errors.New("no external address")

var ErrNoInternalAddress = errors.New("no internal address")

var ErrNoNATFound = errors.New("no NAT found")

Functions

func DiscoverNATs

func DiscoverNATs(ctx context.Context) <-chan NAT

DiscoverNATs returns all NATs discovered in the network.

Types

type NAT

type NAT interface {
	// Type returns the kind of NAT port mapping service that is used
	Type() string

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

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

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

	// AddPortMapping maps a port on the local host to an external port.
	AddPortMapping(protocol string, internalPort int, description string, timeout time.Duration) (mappedExternalPort int, err error)

	// DeletePortMapping removes a port mapping.
	DeletePortMapping(protocol string, internalPort int) (err error)
}

protocol is either "udp" or "tcp"

func DiscoverGateway

func DiscoverGateway() (NAT, error)

DiscoverGateway attempts to find a gateway device.