Welcome to the Godot Reference Fork and the Godot Proposals Fork alternatives. Why?

UPNPDevice

0 0 vote
Article Rating

Inherits: Reference < Object

UPNP device.

Description

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

Methods

intadd_port_mapping ( int port, int port_internal=0, String desc=”“, String proto=”UDP”, int duration=0 ) const
intdelete_port_mapping ( int port, String proto=”UDP” ) const
boolis_valid_gateway ( ) const
Stringquery_external_address ( ) const

Enumerations

enum IGDStatus:

  • IGD_STATUS_OK = 0 — OK.
  • IGD_STATUS_HTTP_ERROR = 1 — HTTP error.
  • IGD_STATUS_HTTP_EMPTY = 2 — Empty HTTP response.
  • 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.

Property Descriptions

Default""
Setterset_description_url(value)
Getterget_description_url()

URL to the device description.


Default""
Setterset_igd_control_url(value)
Getterget_igd_control_url()

IDG control URL.


Default""
Setterset_igd_our_addr(value)
Getterget_igd_our_addr()

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


Default""
Setterset_igd_service_type(value)
Getterget_igd_service_type()

IGD service type.


Default9
Setterset_igd_status(value)
Getterget_igd_status()

IGD status. See IGDStatus.


Default""
Setterset_service_type(value)
Getterget_service_type()

Service type.

Method Descriptions

  • int add_port_mapping ( int port, int port_internal=0, String desc=”“, String 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 UPNP.add_port_mapping.


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

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


  • bool is_valid_gateway ( ) const

Returns true if this is a valid IGD (InternetGatewayDevice) which potentially supports port forwarding.


  • String query_external_address ( ) const

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

Doc ID missing

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 1970-01-01 at 00:00:00. It’s the English Stable version because it’s what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.

Subscribe
Notify of
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x