upnp

Documentation

Index

• type NAT
  • func Discover() (nat NAT, err error)

Types

type NAT

type NAT interface {
	// Get the external address from outside the NAT.
	GetExternalAddress() (addr net.IP, err error)
	// Add a port mapping for protocol (
	// "udp" or "tcp") from external port to internal port with description
	// lasting for timeout.
	AddPortMapping(protocol string, externalPort, internalPort int,
		description string, timeout int) (mappedExternalPort int, err error)
	// Remove a previously added port mapping from external port to internal
	// port.
	DeletePortMapping(protocol string, externalPort,
		internalPort int) (err error)
}

NAT is an interface representing a NAT traversal options for example UPNP or NAT-PMP. It provides methods to query and manipulate this traversal to allow access to services.

func Discover

func Discover() (nat NAT, err error)

Discover searches the local network for a UPnP router returning a NAT for the network if so, nil if not.