diff options
Diffstat (limited to 'doc/classes/IP.xml')
| -rw-r--r-- | doc/classes/IP.xml | 67 |
1 files changed, 33 insertions, 34 deletions
diff --git a/doc/classes/IP.xml b/doc/classes/IP.xml index 152f381a83..8eb994a913 100644 --- a/doc/classes/IP.xml +++ b/doc/classes/IP.xml @@ -4,39 +4,33 @@ Internet protocol (IP) support functions such as DNS resolution. </brief_description> <description> - IP contains support functions for the Internet Protocol (IP). TCP/IP support is in different classes (see [StreamPeerTCP] and [TCP_Server]). IP provides DNS hostname resolution support, both blocking and threaded. + IP contains support functions for the Internet Protocol (IP). TCP/IP support is in different classes (see [StreamPeerTCP] and [TCPServer]). IP provides DNS hostname resolution support, both blocking and threaded. </description> <tutorials> </tutorials> <methods> <method name="clear_cache"> - <return type="void"> - </return> - <argument index="0" name="hostname" type="String" default=""""> - </argument> + <return type="void" /> + <argument index="0" name="hostname" type="String" default="""" /> <description> Removes all of a [code]hostname[/code]'s cached references. If no [code]hostname[/code] is given, all cached IP addresses are removed. </description> </method> <method name="erase_resolve_item"> - <return type="void"> - </return> - <argument index="0" name="id" type="int"> - </argument> + <return type="void" /> + <argument index="0" name="id" type="int" /> <description> Removes a given item [code]id[/code] from the queue. This should be used to free a queue after it has completed to enable more queries to happen. </description> </method> <method name="get_local_addresses" qualifiers="const"> - <return type="Array"> - </return> + <return type="Array" /> <description> - Returns all of the user's current IPv4 and IPv6 addresses as an array. + Returns all the user's current IPv4 and IPv6 addresses as an array. </description> </method> <method name="get_local_interfaces" qualifiers="const"> - <return type="Array"> - </return> + <return type="Array" /> <description> Returns all network adapters as an array. Each adapter is a dictionary of the form: @@ -51,41 +45,46 @@ </description> </method> <method name="get_resolve_item_address" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="id" type="int"> - </argument> + <return type="String" /> + <argument index="0" name="id" type="int" /> <description> Returns a queued hostname's IP address, given its queue [code]id[/code]. Returns an empty string on error or if resolution hasn't happened yet (see [method get_resolve_item_status]). </description> </method> + <method name="get_resolve_item_addresses" qualifiers="const"> + <return type="Array" /> + <argument index="0" name="id" type="int" /> + <description> + Returns resolved addresses, or an empty array if an error happened or resolution didn't happen yet (see [method get_resolve_item_status]). + </description> + </method> <method name="get_resolve_item_status" qualifiers="const"> - <return type="int" enum="IP.ResolverStatus"> - </return> - <argument index="0" name="id" type="int"> - </argument> + <return type="int" enum="IP.ResolverStatus" /> + <argument index="0" name="id" type="int" /> <description> Returns a queued hostname's status as a [enum ResolverStatus] constant, given its queue [code]id[/code]. </description> </method> <method name="resolve_hostname"> - <return type="String"> - </return> - <argument index="0" name="host" type="String"> - </argument> - <argument index="1" name="ip_type" type="int" enum="IP.Type" default="3"> - </argument> + <return type="String" /> + <argument index="0" name="host" type="String" /> + <argument index="1" name="ip_type" type="int" enum="IP.Type" default="3" /> <description> Returns a given hostname's IPv4 or IPv6 address when resolved (blocking-type method). The address type returned depends on the [enum Type] constant given as [code]ip_type[/code]. </description> </method> + <method name="resolve_hostname_addresses"> + <return type="Array" /> + <argument index="0" name="host" type="String" /> + <argument index="1" name="ip_type" type="int" enum="IP.Type" default="3" /> + <description> + Resolves a given hostname in a blocking way. Addresses are returned as an [Array] of IPv4 or IPv6 addresses depending on [code]ip_type[/code]. + </description> + </method> <method name="resolve_hostname_queue_item"> - <return type="int"> - </return> - <argument index="0" name="host" type="String"> - </argument> - <argument index="1" name="ip_type" type="int" enum="IP.Type" default="3"> - </argument> + <return type="int" /> + <argument index="0" name="host" type="String" /> + <argument index="1" name="ip_type" type="int" enum="IP.Type" default="3" /> <description> Creates a queue item to resolve a hostname to an IPv4 or IPv6 address depending on the [enum Type] constant given as [code]ip_type[/code]. Returns the queue ID if successful, or [constant RESOLVER_INVALID_ID] on error. </description> |