Struct UPNP

UPNP network functions.

struct UPNP ;

Provides UPNP functionality to discover UPNPDevices on the local network and execute commands on them, like managing port mappings (port forwarding) and querying the local and remote network IP address. Note that methods on this class are synchronous and block the calling thread. To forward a specific port:

const PORT = 7777 var upnp = UPNP.new() upnp.discover(2000, 2, "InternetGatewayDevice") upnp.add_port_mapping(port)

To close a specific port (e.g. after you have finished using it):

upnp.delete_port_mapping(port)

Properties

NameTypeDescription
discoverIpv6[get, set] boolIf true, IPv6 is used for UPNPDevice discovery.
discoverLocalPort[get, set] longIf 0, the local port to use for discovery is chosen automatically by the system. If 1, discovery will be done from the source port 1900 (same as destination port). Otherwise, the value will be used as the port.
discoverMulticastIf[get, set] StringMulticast interface to use for discovery. Uses the default multicast interface if empty.

Methods

NameDescription
addDevice Adds the given UPNPDevice to the list of discovered devices.
addPortMapping Adds a mapping to forward the external port (between 1 and 65535) on the default gateway (see getGateway) to the internal_port on the local machine for the given protocol proto (either TCP or UDP, with UDP being the default). If a port mapping for the given port and protocol combination already exists on that gateway device, this method tries to overwrite it. If that is not desired, you can retrieve the gateway manually with getGateway and call addPortMapping on it, if any. If internal_port is 0 (the default), the same port number is used for both the external and the internal port (the port value). The description (desc) is shown in some router UIs and can be used to point out which application added the mapping, and the lifetime of the mapping can be limited by duration. However, some routers are incompatible with one or both of these, so use with caution and add fallback logic in case of errors to retry without them if in doubt. See upnpresult for possible return values.
clearDevices Clears the list of discovered devices.
deletePortMapping Deletes the port mapping for the given port and protocol combination on the default gateway (see getGateway) if one exists. port must be a valid port between 1 and 65535, proto can be either TCP or UDP. See upnpresult for possible return values.
discover Discovers local UPNPDevices. Clears the list of previously discovered devices. Filters for IGD (InternetGatewayDevice) type devices by default, as those manage port forwarding. timeout is the time to wait for responses in milliseconds. ttl is the time-to-live; only touch this if you know what you're doing. See upnpresult for possible return values.
getDevice Returns the UPNPDevice at the given index.
getDeviceCount Returns the number of discovered UPNPDevices.
getDiscoverLocalPort
getDiscoverMulticastIf
getGateway Returns the default gateway. That is the first discovered UPNPDevice that is also a valid IGD (InternetGatewayDevice).
isDiscoverIpv6
queryExternalAddress Returns the external IP address of the default gateway (see getGateway) as string. Returns an empty string on error.
removeDevice Removes the device at index from the list of discovered devices.
setDevice Sets the device at index from the list of discovered devices to device.
setDiscoverIpv6
setDiscoverLocalPort
setDiscoverMulticastIf

Enums

NameDescription
Constants
UPNPResult