upnp

Documentation

Overview

Package upnp implements a simple UPnP client suitable for NAT traversal.

Index

• type Client
  • func (c *Client) AddPortMapping(descr string, internalPort, externalPort, duration int) error
  • func (c *Client) Close()
  • func (c *Client) DeletePortMapping(internalPort, externalPort int) error
  • func (c *Client) GetExternalIPAddress() (net.IP, error)
  • func (c *Client) GetListOfPortMappings() ([]string, error)
  • func (c *Client) Vlogf(f string, a ...interface{})
• type ClientFactory
  • func (f *ClientFactory) Name() string
  • func (f *ClientFactory) New(verbose bool) (base.Client, error)

Types

type Client

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

Client is UPnP client instance.

func (*Client) AddPortMapping

func (c *Client) AddPortMapping(descr string, internalPort, externalPort, duration int) error

AddPortMapping adds a new TCP/IP port mapping. The internal IP address of the client is used as the destination. Per the UPnP spec, duration can range from 0 to 604800, with the behavior on 0 changing depending on the version of the spec.

func (*Client) Close

func (c *Client) Close()

func (*Client) DeletePortMapping

func (c *Client) DeletePortMapping(internalPort, externalPort int) error

DeletePortMapping removes an existing TCP/IP port forwarding entry between clientIP:internalPort and 0.0.0.0:externalPort.

func (*Client) GetExternalIPAddress

func (c *Client) GetExternalIPAddress() (net.IP, error)

GetExternalIPAddress queries the router's external IP address.

func (*Client) GetListOfPortMappings

func (c *Client) GetListOfPortMappings() ([]string, error)

GetListOfPortMappings queries the router for the list of port forwarding entries.

func (*Client) Vlogf

func (c *Client) Vlogf(f string, a ...interface{})

type ClientFactory

type ClientFactory struct{}

func (*ClientFactory) Name

func (f *ClientFactory) Name() string

func (*ClientFactory) New

func (f *ClientFactory) New(verbose bool) (base.Client, error)