Index · Object → RefCounted → UPNPDevice

UPNPDevice

Universal Plug and Play (UPnP) device.

Class Description

Universal Plug and Play (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.

Properties

var description_url: String = ""

URL to the device description.

var igd_control_url: String = ""

IDG control URL.

var igd_our_addr: String = ""

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

var igd_service_type: String = ""

IGD service type.

var igd_status: UPNPDevice.IGDStatus = 9

IGD status.

var service_type: String = ""

Service type.

Methods

func add_port_mapping(port: int, port_internal: int = 0, desc: String = "", proto: String = "UDP", duration: int = 0) -> int

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().

func delete_port_mapping(port: int, proto: String = "UDP") -> int

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

func is_valid_gateway() -> bool

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

func query_external_address() -> String

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

Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Object (2)

Enums & Constants

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.