nat

Documentation

Index

• func Map(m Mapper, c chan struct{}, protocol string, extport, intport int, name string)
• type ExtIP
  • func (ExtIP) AddMapping(string, int, int, string, time.Duration) error
  • func (ExtIP) DeleteMapping(string, int, int) error
  • func (n ExtIP) ExternalIP() (net.IP, error)
  • func (n ExtIP) String() string
• type Mapper
  • func Any() Mapper
  • func PMP(gateway net.IP) Mapper
  • func Parse(spec string) (Mapper, error)
  • func UPnP() Mapper

Functions

func Map

func Map(m Mapper, c chan struct{}, protocol string, extport, intport int, name string)

Map adds a port mapping on m and keeps it alive until c is closed. This function is typically invoked in its own goroutine.

Types

type ExtIP

type ExtIP net.IP

ExtIP assumes that the local machine is reachable on the given external IP address, and that any required ports were mapped manually. Mapping operations will not return an error but won't actually do anything.

func (ExtIP) AddMapping

func (ExtIP) AddMapping(string, int, int, string, time.Duration) error

func (ExtIP) DeleteMapping

func (ExtIP) DeleteMapping(string, int, int) error

func (ExtIP) ExternalIP

func (n ExtIP) ExternalIP() (net.IP, error)

func (ExtIP) String

func (n ExtIP) String() string

type Mapper

type Mapper interface {
	AddMapping(protocol string, extport, intport int, name string, lifetime time.Duration) error
	DeleteMapping(protocol string, extport, intport int) error
	ExternalIP() (net.IP, error)
	String() string
}

func Any

func Any() Mapper

Any returns a port mapper that tries to discover any supported mechanism on the local network.

func PMP

func PMP(gateway net.IP) Mapper

PMP returns a port mapper that uses NAT-PMP. The provided gateway address should be the IP of your router. If the given gateway address is nil, PMP will attempt to auto-discover the router.

func Parse

func Parse(spec string) (Mapper, error)

Parse parses a NAT interface description. The following formats are currently accepted. Note that mechanism names are not case-sensitive.

"" or "none"         return nil
"extip:77.12.33.4"   will assume the local machine is reachable on the given IP
"any"                uses the first auto-detected mechanism
"upnp"               uses the Universal Plug and Play protocol
"pmp"                uses NAT-PMP with an auto-detected gateway address
"pmp:192.168.0.1"    uses NAT-PMP with the given gateway address

func UPnP

func UPnP() Mapper

UPnP returns a port mapper that uses UPnP. It will attempt to discover the address of your router using UDP broadcasts.