upnp

package

v0.11.17 Latest Latest Go to latest Published: Jul 26, 2015 License: MPL-2.0 Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/andreajparker/syncthing

Links

Open Source Insights

Documentation ¶

Overview ¶

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

Index ¶

type IGD
- func Discover(timeout time.Duration) []IGD
type IGDService
type Protocol

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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 ¶ added in v0.10.2

func (n *IGD) FriendlyIdentifier() string

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

func (*IGD) FriendlyName ¶ added in v0.10.2

func (n *IGD) FriendlyName() string

func (*IGD) URL ¶ added in v0.10.2

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

func (*IGD) UUID ¶ added in v0.10.2

func (n *IGD) UUID() string

type IGDService ¶ added in v0.10.2

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

An IGDService is a specific service provided by an IGD.

func (*IGDService) AddPortMapping ¶ added in v0.10.2

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 ¶ added in v0.10.2

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

DeletePortMapping deletes a port mapping from the specified IGD service.

func (*IGDService) GetExternalIPAddress ¶ added in v0.10.2

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 ¶ added in v0.10.3

func (s *IGDService) ID() string

type Protocol ¶

type Protocol string

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL