UPNPDevice

    UPNP device.

    UPNP device. See 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

    int

    ( int port, port_internal=0, String desc=””, proto=”UDP”, int duration=0 ) const

    delete_port_mapping ( port, String proto=”UDP” ) const

    is_valid_gateway ( ) const

    Enumerations

    enum IGDStatus:

    • IGD_STATUS_OK = 0 —- OK.

    • IGD_STATUS_HTTP_ERROR = 1 —- HTTP error.

    • IGD_STATUS_NO_URLS = 3 —- Returned response contained no URLs.

    • IGD_STATUS_NO_IGD = 4 —- Not a valid IGD.

    • IGD_STATUS_DISCONNECTED = 5 —- Disconnected.

    • IGD_STATUS_UNKNOWN_DEVICE = 6 —- Unknown device.

    • IGD_STATUS_INVALID_CONTROL = 7 —- Invalid control.

    • IGD_STATUS_MALLOC_ERROR = 8 —- Memory allocation error.

    • IGD_STATUS_UNKNOWN_ERROR = 9 —- Unknown error.

    URL to the device description.

    Default

    “”

    Setter

    set_igd_control_url(value)

    Getter

    get_igd_control_url()

    IDG control URL.

    • igd_our_addr

    Address of the local machine in the network connecting it to this UPNPDevice.

    Default

    Setter

    set_igd_service_type(value)

    Getter

    get_igd_service_type()

    IGD service type.

    • igd_status

    IGD status. See IGDStatus.

    • service_type

    Default

    “”

    Setter

    set_service_type(value)

    Getter

    get_service_type()

    Service type.

    Method Descriptions

    • add_port_mapping ( int port, port_internal=0, String desc=””, proto=”UDP”, int duration=0 ) const

    Adds a port mapping to forward the given external port on this UPNPDevice for the given protocol to the local machine. See .

    • int delete_port_mapping ( port, String proto=”UDP” ) const

    Deletes the port mapping identified by the given port and protocol combination on this device. See .

    • bool is_valid_gateway ( ) const
    • query_external_address ( ) const

    Returns the external IP address of this or an empty string.