View source

class IP

package godot

@:nativeGen@:libType@:csNative@:native("Godot.IP")@:autoBuild(godot.Godot.buildUserClass())

IP contains support functions for the Internet Protocol (IP). TCP/IP support is in different classes (see godot.StreamPeerTCP and godot.TCP_Server). IP provides DNS hostname resolution support, both blocking and threaded.

Static variables

@:native("ResolverInvalidId")staticread onlyRESOLVER_INVALID_ID:Int

Invalid ID constant. Returned if godot.IP.resolverMaxQueries is exceeded.

@:native("ResolverMaxQueries")staticread onlyRESOLVER_MAX_QUERIES:Int

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

@:native("Singleton")staticread onlySINGLETON:Object

Static methods

@:native("ClearCache")staticclearCache(?hostname:String):Void

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

@:native("EraseResolveItem")staticeraseResolveItem(id:Int):Void

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.

@:native("GetLocalAddresses")staticgetLocalAddresses():Array

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

@:native("GetLocalInterfaces")staticgetLocalInterfaces():Array

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

@:native("GetResolveItemAddress")staticgetResolveItemAddress(id:Int):String

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 godot.IP.getResolveItemStatus).

@:native("GetResolveItemAddresses")staticgetResolveItemAddresses(id:Int):Array

Return resolved addresses, or an empty array if an error happened or resolution didn't happen yet (see godot.IP.getResolveItemStatus).

@:native("GetResolveItemStatus")staticgetResolveItemStatus(id:Int):IP_ResolverStatus

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

@:native("ResolveHostname")staticresolveHostname(host:String, ?ipType:IP_Type):String

Returns a given hostname's IPv4 or IPv6 address when resolved (blocking-type method). The address type returned depends on the godot.IP_Type constant given as ip_type.

@:native("ResolveHostnameAddresses")staticresolveHostnameAddresses(host:String, ?ipType:IP_Type):Array

Resolves a given hostname in a blocking way. Addresses are returned as an godot.Collections_Array of IPv4 or IPv6 depending on ip_type.

@:native("ResolveHostnameQueueItem")staticresolveHostnameQueueItem(host:String, ?ipType:IP_Type):Int

Creates a queue item to resolve a hostname to an IPv4 or IPv6 address depending on the godot.IP_Type constant given as ip_type. Returns the queue ID if successful, or godot.IP.resolverInvalidId on error.