IP Class |
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.
Namespace: Godot
public static class IP
The IP type exposes the following members.
| Name | Description | |
|---|---|---|
| ClearCache | Removes all of a hostname's cached references. If no hostname is given, all cached IP addresses are removed. | |
| EraseResolveItem | 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. | |
| GetLocalAddresses | Returns all the user's current IPv4 and IPv6 addresses as an array. | |
| GetLocalInterfaces | Returns all network adapters as an array. Each adapter is a dictionary of the form: {
"index": "1", # Interface index.
"name": "eth0", # Interface name.
"friendly": "Ethernet One", # A friendly name (might be empty).
"addresses": ["192.168.1.101"], # An array of IP addresses associated to this interface.
} | |
| GetResolveItemAddress | 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 GetResolveItemStatus(Int32)). | |
| GetResolveItemStatus | Returns a queued hostname's status as a IPResolverStatus constant, given its queue id. | |
| ResolveHostname | Returns a given hostname's IPv4 or IPv6 address when resolved (blocking-type method). The address type returned depends on the IPType constant given as ip_type. | |
| ResolveHostnameQueueItem | Creates a queue item to resolve a hostname to an IPv4 or IPv6 address depending on the IPType constant given as ip_type. Returns the queue ID if successful, or on error. |
| Name | Description | |
|---|---|---|
| ResolverInvalidId | Invalid ID constant. Returned if is exceeded. | |
| ResolverMaxQueries | Maximum number of concurrent DNS resolver queries allowed, is returned if exceeded. |