IP

Inherits: Object

Inherited By: IP_Unix

Category: Core

Brief Description

IP Protocol support functions.

Member Functions

void

clear_cache ( String arg0=”” )

void

erase_resolve_item ( int id )

Array

get_local_addresses ( ) const

String

get_resolve_item_address ( int id ) const

Array

get_resolve_item_addresses ( int id ) const

int

get_resolve_item_status ( int id ) const

String

resolve_hostname ( String host, int ip_type=3 )

Array

resolve_hostname_addresses ( String host, int ip_type )

int

resolve_hostname_queue_item ( String host, int ip_type=3 )

Numeric Constants

  • RESOLVER_STATUS_NONE = 0

  • RESOLVER_STATUS_WAITING = 1

  • RESOLVER_STATUS_DONE = 2

  • RESOLVER_STATUS_ERROR = 3

  • RESOLVER_MAX_QUERIES = 32

  • RESOLVER_INVALID_ID = -1

  • TYPE_NONE = 0

  • TYPE_IPV4 = 1

  • TYPE_IPV6 = 2

  • TYPE_ANY = 3

Description

IP contains some support functions for the IPv4 protocol. TCP/IP support is in different classes (see StreamPeerTCP and TCP_Server). IP provides hostname resolution support, both blocking and threaded.

Member Function Description

  • void clear_cache ( String arg0=”” )

  • void erase_resolve_item ( int id )

Erase a queue ID, removing it from the queue if needed. This should be used after a queue is completed to free it and enable more queries to happen.

  • Array get_local_addresses ( ) const

  • String get_resolve_item_address ( int id ) const

Return a resolved item address, or an empty string if an error happened or resolution didn’t happen yet (see get_resolve_item_status).

  • Array get_resolve_item_addresses ( int id ) const

Return resolved addresses, or an empty array if an error happened or resolution didn’t happen yet (see get_resolve_item_status).

  • int get_resolve_item_status ( int id ) const

Return the status of hostname queued for resolving, given its queue ID. Returned status can be any of the RESOLVER_STATUS_* enumeration.

Resolve a given hostname, blocking. Resolved hostname is returned as an IPv4 or IPv6 depending on “ip_type”.

Resolve a given hostname, blocking. Addresses are returned as an Array of IPv4 or IPv6 depending on “ip_type”.

  • int resolve_hostname_queue_item ( String host, int ip_type=3 )

Create a queue item for resolving a given hostname to an IPv4 or IPv6 depending on “ip_type”. The queue ID is returned, or RESOLVER_INVALID_ID on error.