upnp

Documentation

Index

• Variables
• type NAT
  • func Discover() (nat NAT, e error)

Variables

var F, E, W, I, D, T log.LevelPrinter = log.GetLogPrinterSet(subsystem)

Types

type NAT

type NAT interface {
	// GetExternalAddress - Get the external address from outside the NAT.
	GetExternalAddress() (addr net.IP, e error)
	// AddPortMapping - 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, e error)
	// DeletePortMapping - Remove a previously added port mapping from external
	// port to internal port.
	DeletePortMapping(
		protocol string, externalPort,
		internalPort int,
	) (e 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, e error)

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