godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current upstream master branch

Browse Source
This commit is contained in:
Rémi Verschelde
2017-09-23 11:01:36 +02:00
parent 5e952ae7d5
commit 0cc4b36524
467 changed files with 5484 additions and 2561 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
classes/class_ip.rst
View File

@@ -1,5 +1,6 @@
.. 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.
.. 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:
@@ -53,7 +54,7 @@ Numeric Constants
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.
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
---------------------------
@@ -62,38 +63,42 @@ Member Function Description
- 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 **)**
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.
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
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>`).
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
Return the status of hostname queued for resolving, given its queue ID. Returned status can be any of the RESOLVER_STATUS\_\* enumeration.
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 **)**
Resolve a given hostname, blocking. Resolved hostname is returned as an IPv4 or IPv6 depending on "ip_type".
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 **)**
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.
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.