Home Explore Help
Sign In
godotengine
/
godot-docs
mirror of https://github.com/godotengine/godot-docs
Watch 1
Star 1
Fork 0
Files
Branch: 3.2
Branches Tags
godot-docs
/
classes
/
class_ip.rst

class_ip.rst 8.6 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the IP.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_IP:
    8. 

  8. 

  9. IP
    10. 

  10. ==
    11. 

  11. 

  12. **Inherits:** :ref:`Object<class_Object>`
    13. 

  13. 

  14. Internet protocol (IP) support functions such as DNS resolution.
    15. 

  15. 

  16. Description
    17. 

  17. -----------
    18. 

  18. 

  19. IP contains support functions for the Internet Protocol (IP). TCP/IP support is in different classes (see :ref:`StreamPeerTCP<class_StreamPeerTCP>` and :ref:`TCP_Server<class_TCP_Server>`). IP provides DNS hostname resolution support, both blocking and threaded.
    20. 

  20. 

  21. Methods
    22. 

  22. -------
    23. 

  23. 

  24. +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    25. 

  25. | void                                          | :ref:`clear_cache<class_IP_method_clear_cache>` **(** :ref:`String<class_String>` hostname="" **)**                                                               |
    26. 

  26. +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    27. 

  27. | void                                          | :ref:`erase_resolve_item<class_IP_method_erase_resolve_item>` **(** :ref:`int<class_int>` id **)**                                                                |
    28. 

  28. +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    29. 

  29. | :ref:`Array<class_Array>`                     | :ref:`get_local_addresses<class_IP_method_get_local_addresses>` **(** **)** |const|                                                                               |
    30. 

  30. +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    31. 

  31. | :ref:`Array<class_Array>`                     | :ref:`get_local_interfaces<class_IP_method_get_local_interfaces>` **(** **)** |const|                                                                             |
    32. 

  32. +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    33. 

  33. | :ref:`String<class_String>`                   | :ref:`get_resolve_item_address<class_IP_method_get_resolve_item_address>` **(** :ref:`int<class_int>` id **)** |const|                                            |
    34. 

  34. +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    35. 

  35. | :ref:`ResolverStatus<enum_IP_ResolverStatus>` | :ref:`get_resolve_item_status<class_IP_method_get_resolve_item_status>` **(** :ref:`int<class_int>` id **)** |const|                                              |
    36. 

  36. +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    37. 

  37. | :ref:`String<class_String>`                   | :ref:`resolve_hostname<class_IP_method_resolve_hostname>` **(** :ref:`String<class_String>` host, :ref:`Type<enum_IP_Type>` ip_type=3 **)**                       |
    38. 

  38. +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39. | :ref:`int<class_int>`                         | :ref:`resolve_hostname_queue_item<class_IP_method_resolve_hostname_queue_item>` **(** :ref:`String<class_String>` host, :ref:`Type<enum_IP_Type>` ip_type=3 **)** |
    40. 

  40. +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

  41. 

  42. Enumerations
    43. 

  43. ------------
    44. 

  44. 

  45. .. _enum_IP_ResolverStatus:
    46. 

  46. 

  47. .. _class_IP_constant_RESOLVER_STATUS_NONE:
    48. 

  48. 

  49. .. _class_IP_constant_RESOLVER_STATUS_WAITING:
    50. 

  50. 

  51. .. _class_IP_constant_RESOLVER_STATUS_DONE:
    52. 

  52. 

  53. .. _class_IP_constant_RESOLVER_STATUS_ERROR:
    54. 

  54. 

  55. enum **ResolverStatus**:
    56. 

  56. 

  57. - **RESOLVER_STATUS_NONE** = **0** --- DNS hostname resolver status: No status.
    58. 

  58. 

  59. - **RESOLVER_STATUS_WAITING** = **1** --- DNS hostname resolver status: Waiting.
    60. 

  60. 

  61. - **RESOLVER_STATUS_DONE** = **2** --- DNS hostname resolver status: Done.
    62. 

  62. 

  63. - **RESOLVER_STATUS_ERROR** = **3** --- DNS hostname resolver status: Error.
    64. 

  64. 

  65. ----
    66. 

  66. 

  67. .. _enum_IP_Type:
    68. 

  68. 

  69. .. _class_IP_constant_TYPE_NONE:
    70. 

  70. 

  71. .. _class_IP_constant_TYPE_IPV4:
    72. 

  72. 

  73. .. _class_IP_constant_TYPE_IPV6:
    74. 

  74. 

  75. .. _class_IP_constant_TYPE_ANY:
    76. 

  76. 

  77. enum **Type**:
    78. 

  78. 

  79. - **TYPE_NONE** = **0** --- Address type: None.
    80. 

  80. 

  81. - **TYPE_IPV4** = **1** --- Address type: Internet protocol version 4 (IPv4).
    82. 

  82. 

  83. - **TYPE_IPV6** = **2** --- Address type: Internet protocol version 6 (IPv6).
    84. 

  84. 

  85. - **TYPE_ANY** = **3** --- Address type: Any.
    86. 

  86. 

  87. Constants
    88. 

  88. ---------
    89. 

  89. 

  90. .. _class_IP_constant_RESOLVER_MAX_QUERIES:
    91. 

  91. 

  92. .. _class_IP_constant_RESOLVER_INVALID_ID:
    93. 

  93. 

  94. - **RESOLVER_MAX_QUERIES** = **32** --- Maximum number of concurrent DNS resolver queries allowed, :ref:`RESOLVER_INVALID_ID<class_IP_constant_RESOLVER_INVALID_ID>` is returned if exceeded.
    95. 

  95. 

  96. - **RESOLVER_INVALID_ID** = **-1** --- Invalid ID constant. Returned if :ref:`RESOLVER_MAX_QUERIES<class_IP_constant_RESOLVER_MAX_QUERIES>` is exceeded.
    97. 

  97. 

  98. Method Descriptions
    99. 

  99. -------------------
    100. 

  100. 

  101. .. _class_IP_method_clear_cache:
    102. 

  102. 

  103. - void **clear_cache** **(** :ref:`String<class_String>` hostname="" **)**
    104. 

  104. 

  105. Removes all of a ``hostname``'s cached references. If no ``hostname`` is given, all cached IP addresses are removed.
    106. 

  106. 

  107. ----
    108. 

  108. 

  109. .. _class_IP_method_erase_resolve_item:
    110. 

  110. 

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

  112. 

  113. 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.
    114. 

  114. 

  115. ----
    116. 

  116. 

  117. .. _class_IP_method_get_local_addresses:
    118. 

  118. 

  119. - :ref:`Array<class_Array>` **get_local_addresses** **(** **)** |const|
    120. 

  120. 

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

  122. 

  123. ----
    124. 

  124. 

  125. .. _class_IP_method_get_local_interfaces:
    126. 

  126. 

  127. - :ref:`Array<class_Array>` **get_local_interfaces** **(** **)** |const|
    128. 

  128. 

  129. Returns all network adapters as an array.
    130. 

  130. 

  131. Each adapter is a dictionary of the form:
    132. 

  132. 

  133. ::
    134. 

  134. 

  135.     {
    136. 

  136.         "index": "1", # Interface index.
    137. 

  137.         "name": "eth0", # Interface name.
    138. 

  138.         "friendly": "Ethernet One", # A friendly name (might be empty).
    139. 

  139.         "addresses": ["192.168.1.101"], # An array of IP addresses associated to this interface.
    140. 

  140.     }
    141. 

  141. 

  142. ----
    143. 

  143. 

  144. .. _class_IP_method_get_resolve_item_address:
    145. 

  145. 

  146. - :ref:`String<class_String>` **get_resolve_item_address** **(** :ref:`int<class_int>` id **)** |const|
    147. 

  147. 

  148. 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_method_get_resolve_item_status>`).
    149. 

  149. 

  150. ----
    151. 

  151. 

  152. .. _class_IP_method_get_resolve_item_status:
    153. 

  153. 

  154. - :ref:`ResolverStatus<enum_IP_ResolverStatus>` **get_resolve_item_status** **(** :ref:`int<class_int>` id **)** |const|
    155. 

  155. 

  156. Returns a queued hostname's status as a :ref:`ResolverStatus<enum_IP_ResolverStatus>` constant, given its queue ``id``.
    157. 

  157. 

  158. ----
    159. 

  159. 

  160. .. _class_IP_method_resolve_hostname:
    161. 

  161. 

  162. - :ref:`String<class_String>` **resolve_hostname** **(** :ref:`String<class_String>` host, :ref:`Type<enum_IP_Type>` ip_type=3 **)**
    163. 

  163. 

  164. Returns a given hostname's IPv4 or IPv6 address when resolved (blocking-type method). The address type returned depends on the :ref:`Type<enum_IP_Type>` constant given as ``ip_type``.
    165. 

  165. 

  166. ----
    167. 

  167. 

  168. .. _class_IP_method_resolve_hostname_queue_item:
    169. 

  169. 

  170. - :ref:`int<class_int>` **resolve_hostname_queue_item** **(** :ref:`String<class_String>` host, :ref:`Type<enum_IP_Type>` ip_type=3 **)**
    171. 

  171. 

  172. Creates a queue item to resolve a hostname to an IPv4 or IPv6 address depending on the :ref:`Type<enum_IP_Type>` constant given as ``ip_type``. Returns the queue ID if successful, or :ref:`RESOLVER_INVALID_ID<class_IP_constant_RESOLVER_INVALID_ID>` on error.
    173. 

  173. 

  174. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    175. 

  175. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    176. 

  176. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    177. 

  177.