| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100 |
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
- .. _class_IP:
- IP
- ==
- **Inherits:** :ref:`Object<class_object>`
- **Inherited By:** :ref:`IP_Unix<class_ip_unix>`
- **Category:** Core
- Brief Description
- -----------------
- IP Protocol support functions.
- Member Functions
- ----------------
- +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`clear_cache<class_IP_clear_cache>` **(** :ref:`String<class_string>` arg0="" **)** |
- +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`erase_resolve_item<class_IP_erase_resolve_item>` **(** :ref:`int<class_int>` id **)** |
- +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Array<class_array>` | :ref:`get_local_addresses<class_IP_get_local_addresses>` **(** **)** const |
- +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_string>` | :ref:`get_resolve_item_address<class_IP_get_resolve_item_address>` **(** :ref:`int<class_int>` id **)** const |
- +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_resolve_item_status<class_IP_get_resolve_item_status>` **(** :ref:`int<class_int>` id **)** const |
- +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_string>` | :ref:`resolve_hostname<class_IP_resolve_hostname>` **(** :ref:`String<class_string>` host, :ref:`int<class_int>` ip_type=3 **)** |
- +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`resolve_hostname_queue_item<class_IP_resolve_hostname_queue_item>` **(** :ref:`String<class_string>` host, :ref:`int<class_int>` ip_type=3 **)** |
- +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
- Numeric Constants
- -----------------
- - **RESOLVER_STATUS_NONE** = **0**
- - **RESOLVER_STATUS_WAITING** = **1**
- - **RESOLVER_STATUS_DONE** = **2**
- - **RESOLVER_STATUS_ERROR** = **3**
- - **RESOLVER_MAX_QUERIES** = **32**
- - **RESOLVER_INVALID_ID** = **-1**
- - **TYPE_NONE** = **0**
- - **TYPE_IPV4** = **1**
- - **TYPE_IPV6** = **2**
- - **TYPE_ANY** = **3**
- Description
- -----------
- IP contains some support functions for the IPv4 protocol. TCP/IP support is in different classes (see :ref:`StreamPeerTCP<class_streampeertcp>` and :ref:`TCP_Server<class_tcp_server>`). IP provides hostname resolution support, both blocking and threaded.
- Member Function Description
- ---------------------------
- .. _class_IP_clear_cache:
- - void **clear_cache** **(** :ref:`String<class_string>` arg0="" **)**
- .. _class_IP_erase_resolve_item:
- - void **erase_resolve_item** **(** :ref:`int<class_int>` id **)**
- Erase a queue ID, removing it from the queue if needed. This should be used after a queue is completed to free it and enable more queries to happen.
- .. _class_IP_get_local_addresses:
- - :ref:`Array<class_array>` **get_local_addresses** **(** **)** const
- .. _class_IP_get_resolve_item_address:
- - :ref:`String<class_string>` **get_resolve_item_address** **(** :ref:`int<class_int>` id **)** const
- Return a resolved item address, or an empty string if an error happened or resolution didn't happen yet (see :ref:`get_resolve_item_status<class_IP_get_resolve_item_status>`).
- .. _class_IP_get_resolve_item_status:
- - :ref:`int<class_int>` **get_resolve_item_status** **(** :ref:`int<class_int>` id **)** const
- Return the status of hostname queued for resolving, given its queue ID. Returned status can be any of the RESOLVER_STATUS\_\* enumeration.
- .. _class_IP_resolve_hostname:
- - :ref:`String<class_string>` **resolve_hostname** **(** :ref:`String<class_string>` host, :ref:`int<class_int>` ip_type=3 **)**
- Resolve a given hostname, blocking. Resolved hostname is returned as an IPv4 or IPv6 depending on "ip_type".
- .. _class_IP_resolve_hostname_queue_item:
- - :ref:`int<class_int>` **resolve_hostname_queue_item** **(** :ref:`String<class_string>` host, :ref:`int<class_int>` ip_type=3 **)**
- Create a queue item for resolving a given hostname to an IPv4 or IPv6 depending on "ip_type". The queue ID is returned, or RESOLVER_INVALID_ID on error.
|
