.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the IP.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _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>` hostname=""  **)**                                                           |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 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>` hostname=""  **)**

Removes all of a "hostname"'s cached references. If no "hostname" is given then all cached IP addresses are removed.

.. _class_IP_erase_resolve_item:

- void  **erase_resolve_item**  **(** :ref:`int<class_int>` id  **)**

Removes a given item "id" from the queue. This should be used to free a queue after it has completed to enable more queries to happen.

.. _class_IP_get_local_addresses:

- :ref:`Array<class_array>`  **get_local_addresses**  **(** **)** const

Returns all of the user's current IPv4 and IPv6 addresses as an array.

.. _class_IP_get_resolve_item_address:

- :ref:`String<class_string>`  **get_resolve_item_address**  **(** :ref:`int<class_int>` id  **)** const

Returns a queued hostname's IP address, given its queue "id". Returns an empty string on error or if resolution hasn't happened 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

Returns a queued hostname's status as a RESOLVER_STATUS\_\* constant, given its queue "id".

.. _class_IP_resolve_hostname:

- :ref:`String<class_string>`  **resolve_hostname**  **(** :ref:`String<class_string>` host, :ref:`int<class_int>` ip_type=3  **)**

Returns a given hostname's IPv4 or IPv6 address when resolved (blocking-type method). The address type returned depends on the TYPE\_\* constant given as "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  **)**

Creates a queue item to resolve a hostname to an IPv4 or IPv6 address depending on the TYPE\_\* constant given as "ip_type". Returns the queue ID if successful, or RESOLVER_INVALID_ID on error.


