IP

Inherits: :ref:`Object<class_Object>`

Inherited By: :ref:`IP_Unix<class_IP_Unix>`

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

Description

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.

Methods

Enumerations

enum ResolverStatus:

• RESOLVER_STATUS_NONE = 0 --- DNS hostname resolver status: No status.
• RESOLVER_STATUS_WAITING = 1 --- DNS hostname resolver status: Waiting.
• RESOLVER_STATUS_DONE = 2 --- DNS hostname resolver status: Done.
• RESOLVER_STATUS_ERROR = 3 --- DNS hostname resolver status: Error.

enum Type:

• TYPE_NONE = 0 --- Address type: None.
• TYPE_IPV4 = 1 --- Address type: Internet protocol version 4 (IPv4).
• TYPE_IPV6 = 2 --- Address type: Internet protocol version 6 (IPv6).
• TYPE_ANY = 3 --- Address type: Any.

Constants

• 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.
• RESOLVER_INVALID_ID = -1 --- Invalid ID constant. Returned if :ref:`RESOLVER_MAX_QUERIES<class_IP_constant_RESOLVER_MAX_QUERIES>` is exceeded.

Method Descriptions

• void clear_cache ( :ref:`String<class_String>` hostname="" )

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

• void erase_resolve_item ( :ref:`int<class_int>` id )

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.

• :ref:`Array<class_Array>` get_local_addresses ( ) const

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

• :ref:`Array<class_Array>` get_local_interfaces ( ) const

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.
}

• :ref:`String<class_String>` get_resolve_item_address ( :ref:`int<class_int>` id ) const

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>`).

• :ref:`ResolverStatus<enum_IP_ResolverStatus>` get_resolve_item_status ( :ref:`int<class_int>` id ) const

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

• :ref:`String<class_String>` resolve_hostname ( :ref:`String<class_String>` host, :ref:`Type<enum_IP_Type>` ip_type=3 )

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.

• :ref:`int<class_int>` resolve_hostname_queue_item ( :ref:`String<class_String>` host, :ref:`Type<enum_IP_Type>` ip_type=3 )

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.