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

Hérite de : RefCounted < Object

Périphérique Universal Plug and Play (UPnP).

Description

Appareil UPNP (Universal Plug And Play). Voir UPNP pour les fonctions UPNP de découverte et utilitaires. Fournit un accès de bas niveau aux commandes UPNP. Permet de gérer les cartes de ports (suivi de port) et de demander des informations réseau sur l'appareil (comme l'adresse IP locale et externe, et le statut). Notez que les méthodes de cette classe sont synchrones et bloquent le fil d'exécution dans lequel ces méthodes sont appelées.

Propriétés

String

description_url

""

String

igd_control_url

""

String

igd_our_addr

""

String

igd_service_type

""

IGDStatus

igd_status

9

String

service_type

""

Méthodes

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

Énumérations

enum IGDStatus: 🔗

IGDStatus IGD_STATUS_OK = 0

D'accord.

IGDStatus IGD_STATUS_HTTP_ERROR = 1

Erreur HTTP.

IGDStatus IGD_STATUS_HTTP_EMPTY = 2

Réponse HTTP vide.

IGDStatus IGD_STATUS_NO_URLS = 3

Obsolète : This value is no longer used.

La réponse retournée ne contenait pas d’URL.

IGDStatus IGD_STATUS_NO_IGD = 4

Ce n'est pas un IGD valide.

IGDStatus IGD_STATUS_DISCONNECTED = 5

Déconnecté.

IGDStatus IGD_STATUS_UNKNOWN_DEVICE = 6

Périphérique inconnu.

IGDStatus IGD_STATUS_INVALID_CONTROL = 7

Contrôle invalide.

IGDStatus IGD_STATUS_MALLOC_ERROR = 8

Obsolète : This value is no longer used.

Erreur d’allocation de mémoire.

IGDStatus IGD_STATUS_UNKNOWN_ERROR = 9

Erreur inconnue.

Descriptions des propriétés

String description_url = "" 🔗

  • void set_description_url(value: String)

  • String get_description_url()

URL de la description de l’appareil.

String igd_control_url = "" 🔗

  • void set_igd_control_url(value: String)

  • String get_igd_control_url()

URL de contrôle IDG.

String igd_our_addr = "" 🔗

  • void set_igd_our_addr(value: String)

  • String get_igd_our_addr()

L'adresse locale sur le réseau de la machine qui se connecte à ce UPNPDevice.

String igd_service_type = "" 🔗

  • void set_igd_service_type(value: String)

  • String get_igd_service_type()

Type de service IGD.

IGDStatus igd_status = 9 🔗

Status IGD.

String service_type = "" 🔗

  • void set_service_type(value: String)

  • String get_service_type()

Type de service.

Descriptions des méthodes

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

Ajoute une carte des ports pour faire passer le port externe donné sur ce UPNPDevice pour le protocole donné à la machine locale. Voir UPNP.add_port_mapping().

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

Supprime la carte des ports identifiée par la combinaison de ports et le protocole donnée sur cet appareil. Voir UPNP.delete_port_mapping().

bool is_valid_gateway() const 🔗

Renvoie true si c'est un IGD (InternetGatewayDevice) valide qui supporte potentiellement le suivi de port.

String query_external_address() const 🔗

Renvoie l'adresse IP externe de ce UPNPDevice, ou une chaîne vide.