IPInfo Class

Properties   Methods   Events   Config Settings   Errors  

The IPInfo class is used to resolve host names to host addresses and vice versa using an asynchronous DNS. The class provides access to other Transmission Control Protocol (TCP)/IP database functions as well.

Syntax

class ipworks.IPInfo

Remarks

The IPInfo class operates asynchronously. Requests are posted to the class by setting a property like host_name or host_address and then waiting for the on_request_complete event. The request_id property identifies the request.

Up to 100 simultaneous requests can be queued at any moment. pending_requests shows the number of pending requests and also may be used to adjust the size of the queue (by dumping a number of the pending requests).

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

adapter_broadcast_address Property

This property includes the broadcast address of the adapter.

Syntax

def get_adapter_broadcast_address() -> str: ...

adapter_broadcast_address = property(get_adapter_broadcast_address, None)

Default Value

""

Remarks

This property contains the broadcast address of the adapter specified by adapter_index.

This property is read-only.

adapter_count Property

This property includes the number of adapters in the system.

Syntax

def get_adapter_count() -> int: ...

adapter_count = property(get_adapter_count, None)

Default Value

0

Remarks

This property shows how many adapters are installed in the system. You can set the adapter_index from 0 to the adapter_count and then examine the adapter properties, such as adapter_description, adapter_name, and adapter_ip_address, to retrieve information about each adapter.

This property is read-only.

adapter_description Property

This property includes the description of the adapter identified by AdapterIndex .

Syntax

def get_adapter_description() -> str: ...

adapter_description = property(get_adapter_description, None)

Default Value

""

Remarks

This property contains the description of the adapter identified by adapter_index, as returned by the system.

NOTE: This functionality is only available in Windows.

This property is read-only.

adapter_device_index Property

This property includes the system index of the adapter identified by AdapterIndex .

Syntax

def get_adapter_device_index() -> int: ...

adapter_device_index = property(get_adapter_device_index, None)

Default Value

0

Remarks

This property contains the system index of the adapter identified by adapter_index, as returned by the system.

This property is read-only.

adapter_dhcp_enabled Property

This property shows whether or not the adapter identified by AdapterIndex has been DHCP enabled.

Syntax

def get_adapter_dhcp_enabled() -> bool: ...

adapter_dhcp_enabled = property(get_adapter_dhcp_enabled, None)

Default Value

FALSE

Remarks

This property indicates whether or not the adapter identified by adapter_index has been DHCP enabled. The Dynamic Host Configuration Protocol (DHCP) is used to automatically assign IP addresses on a network.

NOTE: This functionality is only available in Windows.

This property is read-only.

adapter_dhcp_server Property

This property includes the DHCP server of the adapter identified by AdapterIndex .

Syntax

def get_adapter_dhcp_server() -> str: ...

adapter_dhcp_server = property(get_adapter_dhcp_server, None)

Default Value

""

Remarks

This property contains the DHCP server of the adapter identified by adapter_index. The Dynamic Host Configuration Protocol (DHCP) is used to automatically assign IP addresses on a network.

NOTE: This functionality is only available in Windows.

This property is read-only.

adapter_dns_servers Property

This property includes the DNS server list for the adapter identified by AdapterIndex .

Syntax

def get_adapter_dns_servers() -> str: ...

adapter_dns_servers = property(get_adapter_dns_servers, None)

Default Value

""

Remarks

This property contains a space-separated list of DNS servers for the adapter specified by adapter_index, as returned by the system.

NOTE: This functionality is only available in Windows.

This property is read-only.

adapter_gateway Property

This property includes the default gateway of the adapter identified by AdapterIndex .

Syntax

def get_adapter_gateway() -> str: ...

adapter_gateway = property(get_adapter_gateway, None)

Default Value

""

Remarks

This property contains the default gateway of the adapter identified by adapter_index, as returned by the system.

NOTE: This functionality is only available in Windows.

This property is read-only.

adapter_index Property

This property sets the current adapter.

Syntax

def get_adapter_index() -> int: ...
def set_adapter_index(value: int) -> None: ...

adapter_index = property(get_adapter_index, set_adapter_index)

Default Value

0

Remarks

When this property is set, the class asks the system for information on the adapter with an index of adapter_index. If the system has information, the adapter properties will be populated with the data returned.

adapter_count is the number of adapters located in the system.

adapter_ip_address Property

This property includes the IP address of the adapter identified by AdapterIndex .

Syntax

def get_adapter_ip_address() -> str: ...

adapter_ip_address = property(get_adapter_ip_address, None)

Default Value

""

Remarks

This property contains the IP address of the adapter identified by adapter_index, as returned by the system.

This property is read-only.

adapter_ipv6_address Property

This is the the IPv6 address of the adapter identified by AdapterIndex .

Syntax

def get_adapter_ipv6_address() -> str: ...

adapter_ipv6_address = property(get_adapter_ipv6_address, None)

Default Value

""

Remarks

This is the IPv6 address of the adapter identified by adapter_index, as returned by the system.

NOTE: This functionality is only available in Windows.

Note: This functionality is available only on XP or newer OS versions.

This property is read-only.

adapter_ipv6_link_local_address Property

This property includes the IPv6 link to the local address of the adapter identified by AdapterIndex .

Syntax

def get_adapter_ipv6_link_local_address() -> str: ...

adapter_ipv6_link_local_address = property(get_adapter_ipv6_link_local_address, None)

Default Value

""

Remarks

This property includes the IPv6 link to the local address of the adapter identified by adapter_index, as returned by the system.

NOTE: This functionality is only available in Windows.

This property is read-only.

adapter_lease_expires Property

This property includes the expiration date and time of the lease obtained by the adapter identified by AdapterIndex .

Syntax

def get_adapter_lease_expires() -> str: ...

adapter_lease_expires = property(get_adapter_lease_expires, None)

Default Value

""

Remarks

This property contains the expiration date and time of the lease obtained by the adapter identified by adapter_index, as returned by the system.

NOTE: This functionality is only available in Windows.

This property is read-only.

adapter_lease_obtained Property

This property includes the date and time when the current lease was obtained by the adapter identified by AdapterIndex .

Syntax

def get_adapter_lease_obtained() -> str: ...

adapter_lease_obtained = property(get_adapter_lease_obtained, None)

Default Value

""

Remarks

This property contains the date and time when the current lease was obtained by the adapter identified by adapter_index, as returned by the system.

NOTE: This functionality is only available in Windows.

This property is read-only.

adapter_name Property

This property includes the name of the adapter identified by AdapterIndex .

Syntax

def get_adapter_name() -> str: ...

adapter_name = property(get_adapter_name, None)

Default Value

""

Remarks

This property contains the name of the adapter identified by adapter_index, as returned by the system.

This property is read-only.

adapter_other_ip_addresses Property

This property includes the other IP addresses leased by the adapter specified by AdapterIndex , if any.

Syntax

def get_adapter_other_ip_addresses() -> str: ...

adapter_other_ip_addresses = property(get_adapter_other_ip_addresses, None)

Default Value

""

Remarks

This property contains a space-separated list of any other IP addresses leased by the adapter specified by adapter_index, if any.

NOTE: This functionality is only available in Windows.

This property is read-only.

adapter_physical_address Property

This property includes the physical address of the adapter identified by AdapterIndex .

Syntax

def get_adapter_physical_address() -> str: ...

adapter_physical_address = property(get_adapter_physical_address, None)

Default Value

""

Remarks

This property contains the physical address of the adapter identified by adapter_index, as returned from the system.

Note: This property is not supported in MacOS or iOS.

This property is read-only.

adapter_primary_wins_server Property

This property includes the primary WINS server of the adapter identified by AdapterIndex .

Syntax

def get_adapter_primary_wins_server() -> str: ...

adapter_primary_wins_server = property(get_adapter_primary_wins_server, None)

Default Value

""

Remarks

This property contains the primary WINS server of the adapter identified by adapter_index, as returned by the system.

NOTE: This functionality is only available in Windows.

This property is read-only.

adapter_secondary_wins_server Property

This property includes the secondary WINS server of the adapter identified by AdapterIndex .

Syntax

def get_adapter_secondary_wins_server() -> str: ...

adapter_secondary_wins_server = property(get_adapter_secondary_wins_server, None)

Default Value

""

Remarks

This property contains the secondary WINS server of the adapter identified by adapter_index, as returned by the system.

NOTE: This functionality is only available in Windows.

This property is read-only.

adapter_status Property

This property returns the current status of the adapter.

Syntax

def get_adapter_status() -> str: ...

adapter_status = property(get_adapter_status, None)

Default Value

""

Remarks

This property holds the current status of the adapter specified by adapter_index.

Possible values are as follows:

• "Up"
• "Down"
• "Testing"
• "Unknown"
• "Dormant"
• "NotPresent"
• "LowerLayerDown"

Note: This property is not applicable when UseOldApi is True.

This property is read-only.

adapter_subnet_mask Property

This property includes the subnet of the adapter identified by AdapterIndex .

Syntax

def get_adapter_subnet_mask() -> str: ...

adapter_subnet_mask = property(get_adapter_subnet_mask, None)

Default Value

""

Remarks

This property contains the subnet of the adapter identified by adapter_index, as returned by the system.

This property is read-only.

adapter_type Property

This property includes the type of adapter identified by AdapterIndex .

Syntax

def get_adapter_type() -> str: ...

adapter_type = property(get_adapter_type, None)

Default Value

""

Remarks

This property contains the type of adapter identified by adapter_index, as returned by the system.

Possible values include the following:

Possible values include the following (Unix OS):

This property is read-only.

adapter_uses_wins Property

This property includes the shows whether or not the adapter identified by AdapterIndex uses WINS.

Syntax

def get_adapter_uses_wins() -> bool: ...

adapter_uses_wins = property(get_adapter_uses_wins, None)

Default Value

FALSE

Remarks

This property indicates whether or not the adapter identified by adapter_index uses WINS. Windows Internet Name Service (WINS) is a name resolution service that is used to resolve Windows network hostnames to IP addresses.

NOTE: This functionality is only available in Windows.

This property is read-only.

adapter_zone_id Property

This property includes the zone Id of the adapter identified by AdapterIndex .

Syntax

def get_adapter_zone_id() -> int: ...

adapter_zone_id = property(get_adapter_zone_id, None)

Default Value

0

Remarks

Also known as a scope Id, the zone Id specifies the IPv6 zone to which the current adapter belongs. The values of the zone Id are defined relative to the sending host. When using an IPv6-enabled XP operating system, the zone Id of the sender MUST be appended after a "%" to the desired IPv6 address. This is an integer value on Windows systems.

NOTE: This functionality is only available in Windows.

Note: This functionality is only available on XP or newer OS versions.

This property is read-only.

arp_proxy Property

This property shows whether the local computer is acting as an Address Resolution Protocol (ARP) proxy.

Syntax

def get_arp_proxy() -> bool: ...

arp_proxy = property(get_arp_proxy, None)

Default Value

FALSE

Remarks

This property indicates whether the local computer is acting as an ARP proxy. If True, the local computer will act as an ARP proxy and will respond to ARP requests with its own hardware address.

NOTE: This functionality is only available in Windows.

This property is read-only.

dhcp_scope Property

This property includes the DHCP scope of the DHCP server.

Syntax

def get_dhcp_scope() -> str: ...

dhcp_scope = property(get_dhcp_scope, None)

Default Value

""

Remarks

This property contains a range of IP addresses that the Dynamic Host Configuration Protocol (DHCP) server can lease to clients.

NOTE: This functionality is only available in Windows.

This property is read-only.

dns_enabled Property

This property shows whether DNS is enabled on the local computer.

Syntax

def get_dns_enabled() -> bool: ...

dns_enabled = property(get_dns_enabled, None)

Default Value

FALSE

Remarks

This property indicates whether DNS is enabled on the local computer. If True, DNS is enabled, and name resolution will be available.

NOTE: This functionality is only available in Windows.

This property is read-only.

dns_server Property

This property includes the address of the DNS server.

Syntax

def get_dns_server() -> str: ...

dns_server = property(get_dns_server, None)

Default Value

""

Remarks

The class attempts to find the default DNS server for the machine where it is installed, and to provide it in this property.

If the class cannot determine the default DNS server address, this property value will be an empty string.

NOTE: This functionality is only available in Windows.

This property is read-only.

domain_name Property

This property includes the current network domain on which the system resides.

Syntax

def get_domain_name() -> str: ...

domain_name = property(get_domain_name, None)

Default Value

""

Remarks

This property contains the domain name to which the system is joined.

NOTE: This functionality is only available in Windows.

This property is read-only.

host_address Property

This property includes an internet address in dotted format. When set, it initiates a search for the corresponding host name.

Syntax

def get_host_address() -> str: ...
def set_host_address(value: str) -> None: ...

host_address = property(get_host_address, set_host_address)

Default Value

""

Remarks

This property contains the IP address (in internet dotted format aaa.bbb.ccc.ddd) of the host whose domain name is specified by host_name

If host_address is set to an IP address, a search is initiated for the corresponding host names(s).

The on_request_complete event is fired when the search is complete. The request_id property identifies the pending request.

Example. Resolve an Address:

IPInfoControl.HostAddress = "10.0.1.10" While IPInfoControl.PendingRequests > 0 IPInfoControl.DoEvents() End While ResolvedName = IPInfoControl.HostName

host_aliases Property

This property includes other names corresponding to the host with the name HostName.

Syntax

def get_host_aliases() -> str: ...

host_aliases = property(get_host_aliases, None)

Default Value

""

Remarks

This property contains a list of alternate names for the host specified by host_name and host_address separated by spaces.

This property is read-only.

host_name Property

This property includes the domain name of an internet host. When set, it initiates a search for the corresponding address(es).

Syntax

def get_host_name() -> str: ...
def set_host_name(value: str) -> None: ...

host_name = property(get_host_name, set_host_name)

Default Value

""

Remarks

This property contains the domain name of the host whose IP address is specified by host_address.

If this property is set to a domain name, a search is initiated for the corresponding host address(s).

The on_request_complete event is fired when the search is complete. The request_id property identifies the pending request.

Example. Resolve a Name:

IPInfoControl.HostName = "MyHostName" While IPInfoControl.PendingRequests > 0 IPInfoControl.DoEvents() End While ResolvedAddress = IPInfoControl.HostAddress

local_host Property

This property includes the name of the local host.

Syntax

def get_local_host() -> str: ...

local_host = property(get_local_host, None)

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call. If the user has assigned an IP address, it will contain the value of that address.

This property is read-only.

node_type Property

This property includes the type of node for the system.

Syntax

def get_node_type() -> str: ...

node_type = property(get_node_type, None)

Default Value

""

Remarks

This property contains the type of node for the system. Possible values include BROADCAST, PEERTOPEER, MIXED, and HYBRID.

NOTE: This functionality is only available in Windows.

This property is read-only.

other_addresses Property

This property includes other addresses for the host identified by HostName (for multihomed hosts).

Syntax

def get_other_addresses() -> str: ...

other_addresses = property(get_other_addresses, None)

Default Value

""

Remarks

This property contains a list of alternate addresses for the host specified by host_name and host_address separated by spaces. Most hosts have only one IP interface. This property is useful when querying multihomed hosts (hosts with more than one interface).

This property is read-only.

other_dns_servers Property

This property includes other DNS servers configured for the host machine.

Syntax

def get_other_dns_servers() -> str: ...

other_dns_servers = property(get_other_dns_servers, None)

Default Value

""

Remarks

This property contains a space-separated list of DNS servers configured for the host machine. Note: The primary server is provided in the dns_server property.

NOTE: This functionality is only available in Windows.

This property is read-only.

pending_requests Property

This property includes the number of requests awaiting completion.

Syntax

def get_pending_requests() -> int: ...
def set_pending_requests(value: int) -> None: ...

pending_requests = property(get_pending_requests, set_pending_requests)

Default Value

0

Remarks

This property serves two functions: it shows the number of requests that are pending completion, and it also can be used to adjust the size of the queue by dumping part or all of the pending requests.

To cancel all the pending requests at any moment, simply set pending_requests to 0.

NOTE: This functionality is only available in Windows.

request_id Property

This property includes the handle of the last request.

Syntax

def get_request_id() -> int: ...

request_id = property(get_request_id, None)

Default Value

0

Remarks

This property contains the handle of the last request.

This handle can be used later to identify the request when the on_request_complete event is fired.

NOTE: This functionality is only available in Windows.

This property is read-only.

routing_enabled Property

This property shows whether routing is enabled on the local computer.

Syntax

def get_routing_enabled() -> bool: ...

routing_enabled = property(get_routing_enabled, None)

Default Value

FALSE

Remarks

This property indicates whether routing is enabled on the local computer.

NOTE: This functionality is only available in Windows.

This property is read-only.

service_aliases Property

This property includes other names by which the service specified by ServiceName / ServicePort is known.

Syntax

def get_service_aliases() -> str: ...

service_aliases = property(get_service_aliases, None)

Default Value

""

Remarks

This property contains a list of alternate service names separated by spaces. In most cases, this list is empty.

NOTE: This functionality is only available in Windows.

This property is read-only.

service_name Property

This property includes the name for a service. When set, it initiates a search for the corresponding port number and protocol.

Syntax

def get_service_name() -> str: ...
def set_service_name(value: str) -> None: ...

service_name = property(get_service_name, set_service_name)

Default Value

""

Remarks

This property contains the name of the specified service located at service_port.

If this property is set to a service name, a search is initiated for the corresponding service_port and other information related to the service (if any).

The on_request_complete event is fired when the search is complete. request_id identifies the pending request.

NOTE: This functionality is only available in Windows.

service_port Property

This property includes a port number for a service. When set, it initiates a search for the corresponding service name and protocol.

Syntax

def get_service_port() -> int: ...
def set_service_port(value: int) -> None: ...

service_port = property(get_service_port, set_service_port)

Default Value

0

Remarks

This property contains the port number for the service specified by service_name.

If this property is set to a port number, a search is initiated for the service_name and other information related to the service (if any).

The on_request_complete event is fired when the search is complete. request_id identifies the pending request.

NOTE: This functionality is only available in Windows.

service_protocol Property

This property includes the protocol of the service specified by ServiceName / ServicePort .

Syntax

def get_service_protocol() -> str: ...
def set_service_protocol(value: str) -> None: ...

service_protocol = property(get_service_protocol, set_service_protocol)

Default Value

""

Remarks

This property contains the protocol for the service specified by service_name.

Setting this property to a particular protocol name (e.g., 'udp' or 'tcp') will force a search for a service for that protocol only. If this property is set to "" (empty string), then the first entry for the service will be returned and this property will be set to the corresponding protocol.

NOTE: This functionality is only available in Windows.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

dhcp_release Method

This method releases the IP address of the current adapter specified by AdapterIndex .

Syntax

def dhcp_release() -> None: ...

Remarks

This method releases the IP address of the current adapter specified by adapter_index. If adapter_dhcp_enabled is True, the lease of the IP address assigned to the current adapter specified by adapter_index is released.

NOTE: This functionality is only available in Windows.

dhcp_renew Method

This method renews the IP address of the current adapter specified by AdapterIndex .

Syntax

def dhcp_renew() -> None: ...

Remarks

This method renews the IP address of the current adapter specified by AdapterIndex. If adapter_dhcp_enabled is True, the lease of the IP address assigned to the current adapter specified by adapter_index is renewed.

NOTE: This functionality is only available in Windows.

display_dns_cache Method

This method displays cached DNS entries.

Syntax

def display_dns_cache() -> str: ...

Remarks

This method displays details of the locally cached DNS records.

This method will return a string with information about the DNS cache. In addition the on_dns_cache_entry event will fire once per cached entry.

The returned value is in the following format:

docs.google.com
----------------------------------------
Record Name . . . . . : docs.google.com
Record Type . . . . . : 1(A)
Time To Live  . . . . : 48
Data Length . . . . . : 4
Section . . . . . . . : Answer
A Record  . . . . . . : 216.58.218.238

NOTE: This functionality is only available in Windows.

do_events Method

Processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

flush_dns_cache Method

This method flushes the DNS cache.

Syntax

def flush_dns_cache() -> bool: ...

Remarks

This method flushes the DNS cache for the system.

NOTE: This functionality is only available in Windows.

get_mac Method

This method returns the MAC address of the network interface at IPAddress .

Syntax

def get_mac(ip_address: str) -> str: ...

Remarks

This method returns the unique Media Access Control (MAC) address of the network interface at IPAddress.

NOTE: This functionality is only available in Windows.

reset Method

This method resets the class, stopping all pending requests and refreshing network information.

Syntax

def reset() -> None: ...

Remarks

This method resets the class, stopping all pending requests and refreshing network information. If the network configuration has changed, call this method to retrieve the latest information.

resolve_address Method

This method resolves an IP address.

Syntax

def resolve_address(host_address: str) -> str: ...

Remarks

This method resolves the IP address HostAddress and sets host_name to the name of the host corresponding to HostAddress.

Calling this method is equivalent to setting the host_address property to HostAddress.

Example. Resolve an Address:

IPInfoControl.ResolveAddress ("10.0.1.10") While (IPInfoControl.PendingRequests > 0) IPInfoControl.DoEvents Wend Debug.Print IPInfoControl.HostName

resolve_name Method

This method resolves a host name.

Syntax

def resolve_name(host_name: str) -> str: ...

Remarks

This method resolves the host name HostName and sets host_address to the IP address of the host corresponding to HostName.

Calling this method is equivalent to setting the host_name property to HostName.

Example. Resolve a Name:

IPInfoControl.ResolveName ("MyHostName") While (IPInfoControl.PendingRequests > 0) IPInfoControl.DoEvents Wend Debug.Print IPInfoControl.HostAddress

on_dns_cache_entry Event

This event fires once for each cached DNS entry.

Syntax

class IPInfoDNSCacheEntryEventParams(object):
  @property
  def record_name() -> str: ...

  @property
  def record_type() -> int: ...

  @property
  def time_to_live() -> int: ...

  @property
  def data_length() -> int: ...

  @property
  def section() -> str: ...

  @property
  def record_value() -> str: ...

  @property
  def record_info() -> str: ...

# In class IPInfo:
@property
def on_dns_cache_entry() -> Callable[[IPInfoDNSCacheEntryEventParams], None]: ...
@on_dns_cache_entry.setter
def on_dns_cache_entry(event_hook: Callable[[IPInfoDNSCacheEntryEventParams], None]) -> None: ...

Remarks

This event fires once for each entry in the local DNS cache when display_dns_cache is called.

RecordName is the host name to which the record applies.

RecordType is the type of response. For instance 1 is an A record.

TimeToLive is the time in seconds after which the cached entry expires.

DataLength is the length of the data in bytes. For instance, if the RecordType is A and an IPv4 address is cached, its DataLength would be 4. CNAME and PTR records will contain the length of the address in memory where the value is held.

Section is the section of the DNS response from which the record is taken. Most commonly, this is the "Answer" section.

RecordValue is the actual value that is cached. For instance this may be an IP address for A records.

RecordInfo is a text representation of the other parameters. This is suitable for use in a log file or to display.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class IPInfoErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class IPInfo:
@property
def on_error() -> Callable[[IPInfoErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[IPInfoErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_request_complete Event

This event is fired after an asynchronous request completes.

Syntax

class IPInfoRequestCompleteEventParams(object):
  @property
  def request_id() -> int: ...

  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class IPInfo:
@property
def on_request_complete() -> Callable[[IPInfoRequestCompleteEventParams], None]: ...
@on_request_complete.setter
def on_request_complete(event_hook: Callable[[IPInfoRequestCompleteEventParams], None]) -> None: ...

Remarks

The RequestId parameter specifies the request that just completed. The class properties that relate to this request are completed with the returned values. For example, in the case of domain name resolution, host_name, host_address, host_aliases, and other_addresses are set to the resolved values.

If the request completed normally, StatusCode is 0, and Description is "OK". If not, StatusCode has the error code returned by the system. Description contains a description of this code.

Please refer to the Error Codes section for more information.

NOTE: This functionality is only available in Windows.

IPInfo Config Settings

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

IPInfo Config Settings

Base Config Settings

IPInfo Errors

IPInfo Errors

	131   Request queue is full.
	132   Message for unknown request.
	134   Invalid address string.
	310   Adapter information is unavailable.

SSL Errors

	270   Cannot load specified security library.
	271   Cannot open certificate store.
	272   Cannot find specified certificate.
	273   Cannot acquire security credentials.
	274   Cannot find certificate chain.
	275   Cannot verify certificate chain.
	276   Error during handshake.
	280   Error verifying certificate.
	281   Could not find client certificate.
	282   Could not find server certificate.
	283   Error encrypting data.
	284   Error decrypting data.

TCP/IP Errors

	10004   [10004] Interrupted system call.
	10009   [10009] Bad file number.
	10013   [10013] Access denied.
	10014   [10014] Bad address.
	10022   [10022] Invalid argument.
	10024   [10024] Too many open files.
	10035   [10035] Operation would block.
	10036   [10036] Operation now in progress.
	10037   [10037] Operation already in progress.
	10038   [10038] Socket operation on non-socket.
	10039   [10039] Destination address required.
	10040   [10040] Message too long.
	10041   [10041] Protocol wrong type for socket.
	10042   [10042] Bad protocol option.
	10043   [10043] Protocol not supported.
	10044   [10044] Socket type not supported.
	10045   [10045] Operation not supported on socket.
	10046   [10046] Protocol family not supported.
	10047   [10047] Address family not supported by protocol family.
	10048   [10048] Address already in use.
	10049   [10049] Can't assign requested address.
	10050   [10050] Network is down.
	10051   [10051] Network is unreachable.
	10052   [10052] Net dropped connection or reset.
	10053   [10053] Software caused connection abort.
	10054   [10054] Connection reset by peer.
	10055   [10055] No buffer space available.
	10056   [10056] Socket is already connected.
	10057   [10057] Socket is not connected.
	10058   [10058] Can't send after socket shutdown.
	10059   [10059] Too many references, can't splice.
	10060   [10060] Connection timed out.
	10061   [10061] Connection refused.
	10062   [10062] Too many levels of symbolic links.
	10063   [10063] File name too long.
	10064   [10064] Host is down.
	10065   [10065] No route to host.
	10066   [10066] Directory not empty
	10067   [10067] Too many processes.
	10068   [10068] Too many users.
	10069   [10069] Disc Quota Exceeded.
	10070   [10070] Stale NFS file handle.
	10071   [10071] Too many levels of remote in path.
	10091   [10091] Network subsystem is unavailable.
	10092   [10092] WINSOCK DLL Version out of range.
	10093   [10093] Winsock not loaded yet.
	11001   [11001] Host not found.
	11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	11004   [11004] Valid name, no data record (check DNS setup).