Click or drag to resize

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.

Inheritance Hierarchy
SystemObject
  GodotIP

Namespace:  Godot
Assembly:  GodotSharp (in GodotSharp.dll) Version: 1.0.0
Syntax
C#
public static class IP

The IP type exposes the following members.

Properties
  NameDescription
Public propertyStatic memberSingleton
Top
Methods
  NameDescription
Public methodStatic memberClearCache

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

Public methodStatic memberEraseResolveItem

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.

Public methodStatic memberGetLocalAddresses

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

Public methodStatic memberGetLocalInterfaces

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

Public methodStatic memberGetResolveItemAddress

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

Public methodStatic memberGetResolveItemStatus

Returns a queued hostname's status as a IPResolverStatus constant, given its queue id.

Public methodStatic memberResolveHostname

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.

Public methodStatic memberResolveHostnameQueueItem

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.

Top
Fields
  NameDescription
Public fieldStatic memberResolverInvalidId

Invalid ID constant. Returned if is exceeded.

Public fieldStatic memberResolverMaxQueries

Maximum number of concurrent DNS resolver queries allowed, is returned if exceeded.

Top
See Also