nat

README

go-nat

Documentation

Overview

Package nat implements NAT handling facilities

Index

• Variables
• 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")

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, externalPort int, description string, timeout time.Duration) (err error)

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

protocol is either "udp" or "tcp"

func DiscoverGateway

func DiscoverGateway() (NAT, error)

DiscoverGateway attempts to find a gateway device.