Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

UPNPDevice

Наследует: RefCounted < Object

Устройство Universal Plug and Play (UPnP).

Описание

Устройство Universal Plug and Play (UPnP). См. UPNP для обнаружения UPnP и служебных функций. Предоставляет низкоуровневый доступ к командам управления UPNP. Позволяет управлять сопоставлениями портов (переадресацией портов) и запрашивать сетевую информацию устройства (например, локальный и внешний IP-адрес и статус). Обратите внимание, что методы этого класса являются синхронными и блокируют вызывающий поток.

Свойства

String

description_url

""

String

igd_control_url

""

String

igd_our_addr

""

String

igd_service_type

""

IGDStatus

igd_status

9

String

service_type

""

Методы

int

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

int

delete_port_mapping(port: int, proto: String = "UDP") const

bool

is_valid_gateway() const

String

query_external_address() const

Перечисления

enum IGDStatus: 🔗

IGDStatus IGD_STATUS_OK = 0

OK.

IGDStatus IGD_STATUS_HTTP_ERROR = 1

Ошибка HTTP.

IGDStatus IGD_STATUS_HTTP_EMPTY = 2

Пустой HTTP-ответ.

IGDStatus IGD_STATUS_NO_URLS = 3

Устарело: This value is no longer used.

Возвращенный ответ не содержал URL-адресов.

IGDStatus IGD_STATUS_NO_IGD = 4

Недействительный IGD.

IGDStatus IGD_STATUS_DISCONNECTED = 5

Отключен.

IGDStatus IGD_STATUS_UNKNOWN_DEVICE = 6

Неизвестное устройство.

IGDStatus IGD_STATUS_INVALID_CONTROL = 7

Неверный контроль.

IGDStatus IGD_STATUS_MALLOC_ERROR = 8

Устарело: This value is no longer used.

Ошибка распределения памяти.

IGDStatus IGD_STATUS_UNKNOWN_ERROR = 9

Неизвестная ошибка.

Описания свойств

String description_url = "" 🔗

  • void set_description_url(value: String)

  • String get_description_url()

URL-адрес описания устройства.

String igd_control_url = "" 🔗

  • void set_igd_control_url(value: String)

  • String get_igd_control_url()

IDG контрольный URL.

String igd_our_addr = "" 🔗

  • void set_igd_our_addr(value: String)

  • String get_igd_our_addr()

Адрес локальной машины в сети, подключающей ее к этому UPNPDevice.

String igd_service_type = "" 🔗

  • void set_igd_service_type(value: String)

  • String get_igd_service_type()

Тип службы IGD.

IGDStatus igd_status = 9 🔗

Статус IGD.

String service_type = "" 🔗

  • void set_service_type(value: String)

  • String get_service_type()

Тип услуг.

Описания метода

int add_port_mapping(port: int, port_internal: int = 0, desc: String = "", proto: String = "UDP", duration: int = 0) const 🔗

Добавляет сопоставление портов для переадресации указанного внешнего порта на этом UPNPDevice для указанного протокола на локальную машину. См. UPNP.add_port_mapping().

int delete_port_mapping(port: int, proto: String = "UDP") const 🔗

Удаляет сопоставление портов, идентифицированное заданной комбинацией порта и протокола на этом устройстве. См. UPNP.delete_port_mapping().

bool is_valid_gateway() const 🔗

Возвращает true, если это допустимый IGD (InternetGatewayDevice), который потенциально поддерживает переадресацию портов.

String query_external_address() const 🔗

Возвращает внешний IP-адрес этого UPNPDevice или пустую строку.