Struct IPSingleton
Internet protocol (IP) support functions such as DNS resolution.
struct IPSingleton
;
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.
Methods
| 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 of 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: |
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).
|
getResolveItemStatus
|
Returns a queued hostname's status as a resolverstatus 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 type constant given as ip_type.
|
resolveHostnameQueueItem
|
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 constant RESOLVER_INVALID_ID on error.
|
Enums
| Name | Description |
|---|---|
Constants
|
|
ResolverStatus
|
|
Type
|