Struct UPNPDevice

UPNP device.

struct UPNPDevice ;

See UPNP for UPNP discovery and utility functions. Provides low-level access to UPNP control commands. Allows to manage port mappings (port forwarding) and to query network information of the device (like local and external IP address and status). Note that methods on this class are synchronous and block the calling thread.

Properties

NameTypeDescription
descriptionUrl[get, set] StringURL to the device description.
igdControlUrl[get, set] StringIDG control URL.
igdOurAddr[get, set] StringAddress of the local machine in the network connecting it to this UPNPDevice.
igdServiceType[get, set] StringIGD service type.
igdStatus[get, set] UPNPDevice.IGDStatusIGD status. See igdstatus.
serviceType[get, set] StringService type.

Methods

NameDescription
addPortMapping Adds a port mapping to forward the given external port on this UPNPDevice for the given protocol to the local machine. See UPNP.addPortMapping.
deletePortMapping Deletes the port mapping identified by the given port and protocol combination on this device. See UPNP.deletePortMapping.
getDescriptionUrl
getIgdControlUrl
getIgdOurAddr
getIgdServiceType
getIgdStatus
getServiceType
isValidGateway Returns true if this is a valid IGD (InternetGatewayDevice) which potentially supports port forwarding.
queryExternalAddress Returns the external IP address of this UPNPDevice or an empty string.
setDescriptionUrl
setIgdControlUrl
setIgdOurAddr
setIgdServiceType
setIgdStatus
setServiceType

Enums

NameDescription
Constants
IGDStatus