upnp

Documentation

Overview

Package upnp implements UPnP InternetGatewayDevice discovery, querying, and port mapping.

Index

• type IGD
  • func Discover(timeout time.Duration) []IGD
  • func (n *IGD) AddPortMapping(protocol Protocol, externalPort, internalPort int, description string, ...) error
  • func (n *IGD) DeletePortMapping(protocol Protocol, externalPort int) error
  • func (n *IGD) FriendlyIdentifier() string
  • func (n *IGD) FriendlyName() string
  • func (n *IGD) URL() *url.URL
  • func (n *IGD) UUID() string
• type IGDService
  • func (s *IGDService) AddPortMapping(localIPAddress string, protocol Protocol, externalPort, internalPort int, ...) error
  • func (s *IGDService) DeletePortMapping(protocol Protocol, externalPort int) error
  • func (s *IGDService) GetExternalIPAddress() (net.IP, error)
  • func (s *IGDService) ID() string
• type Protocol

Types

type IGD

type IGD struct {
	// contains filtered or unexported fields
}

An IGD is a UPnP InternetGatewayDevice.

func Discover

func Discover(timeout time.Duration) []IGD

Discover discovers UPnP InternetGatewayDevices. The order in which the devices appear in the results list is not deterministic.

func (*IGD) AddPortMapping

func (n *IGD) AddPortMapping(protocol Protocol, externalPort, internalPort int, description string, timeout int) error

AddPortMapping adds a port mapping to all relevant services on the specified InternetGatewayDevice. Port mapping will fail and return an error if action is fails for _any_ of the relevant services. For this reason, it is generally better to configure port mapping for each individual service instead.

func (*IGD) DeletePortMapping

func (n *IGD) DeletePortMapping(protocol Protocol, externalPort int) error

DeletePortMapping deletes a port mapping from all relevant services on the specified InternetGatewayDevice. Port mapping will fail and return an error if action is fails for _any_ of the relevant services. For this reason, it is generally better to configure port mapping for each individual service instead.

func (*IGD) FriendlyIdentifier

func (n *IGD) FriendlyIdentifier() string

FriendlyIdentifier returns a friendly identifier (friendly name + IP address) for the IGD.

func (*IGD) FriendlyName

func (n *IGD) FriendlyName() string

func (*IGD) URL

func (n *IGD) URL() *url.URL

func (*IGD) UUID

func (n *IGD) UUID() string

type IGDService

type IGDService struct {
	// contains filtered or unexported fields
}

An IGDService is a specific service provided by an IGD.

func (*IGDService) AddPortMapping

func (s *IGDService) AddPortMapping(localIPAddress string, protocol Protocol, externalPort, internalPort int, description string, timeout int) error

AddPortMapping adds a port mapping to the specified IGD service.

func (*IGDService) DeletePortMapping

func (s *IGDService) DeletePortMapping(protocol Protocol, externalPort int) error

DeletePortMapping deletes a port mapping from the specified IGD service.

func (*IGDService) GetExternalIPAddress

func (s *IGDService) GetExternalIPAddress() (net.IP, error)

GetExternalIPAddress queries the IGD service for its external IP address. Returns nil if the external IP address is invalid or undefined, along with any relevant errors

func (*IGDService) ID

func (s *IGDService) ID() string

type Protocol

type Protocol string

const (
	TCP Protocol = "TCP"
	UDP          = "UDP"
)