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

ipworks.IPInfo

Remarks

The IPInfo class operates asynchronously. Requests are posted to the class by setting a property like HostName or HostAddress and then waiting for the RequestComplete event. The RequestId property identifies the request.

Up to 100 simultaneous requests can be queued at any moment. PendingRequests 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.

AdapterBroadcastAddress Property (IPInfo Class)

This property includes the broadcast address of the adapter.

Syntax

public String getAdapterBroadcastAddress();

Default Value

""

Remarks

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

This property is read-only.

AdapterCount Property (IPInfo Class)

This property includes the number of adapters in the system.

Syntax

public int getAdapterCount();

Default Value

0

Remarks

This property shows how many adapters are installed in the system. You can set the AdapterIndex from 0 to the AdapterCount and then examine the adapter properties, such as AdapterDescription, AdapterName, and AdapterIPAddress, to retrieve information about each adapter.

This property is read-only.

AdapterDescription Property (IPInfo Class)

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

Syntax

public String getAdapterDescription();

Default Value

""

Remarks

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

Note: This functionality is only available in Windows.

This property is read-only.

AdapterDeviceIndex Property (IPInfo Class)

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

Syntax

public int getAdapterDeviceIndex();

Default Value

0

Remarks

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

This property is read-only.

AdapterDHCPEnabled Property (IPInfo Class)

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

Syntax

public boolean isAdapterDHCPEnabled();

Default Value

False

Remarks

This property indicates whether or not the adapter identified by AdapterIndex 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.

AdapterDHCPServer Property (IPInfo Class)

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

Syntax

public String getAdapterDHCPServer();

Default Value

""

Remarks

This property contains the DHCP server of the adapter identified by AdapterIndex. 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.

AdapterGateway Property (IPInfo Class)

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

Syntax

public String getAdapterGateway();

Default Value

""

Remarks

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

Note: This functionality is only available in Windows.

This property is read-only.

AdapterIndex Property (IPInfo Class)

This property sets the current adapter.

Syntax

public int getAdapterIndex();
public void setAdapterIndex(int adapterIndex);

Default Value

0

Remarks

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

AdapterCount is the number of adapters located in the system.

AdapterIPAddress Property (IPInfo Class)

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

Syntax

public String getAdapterIPAddress();

Default Value

""

Remarks

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

This property is read-only.

AdapterLeaseExpires Property (IPInfo Class)

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

Syntax

public String getAdapterLeaseExpires();

Default Value

""

Remarks

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

Note: This functionality is only available in Windows.

This property is read-only.

AdapterLeaseObtained Property (IPInfo Class)

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

Syntax

public String getAdapterLeaseObtained();

Default Value

""

Remarks

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

Note: This functionality is only available in Windows.

This property is read-only.

AdapterName Property (IPInfo Class)

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

Syntax

public String getAdapterName();

Default Value

""

Remarks

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

This property is read-only.

AdapterOtherIPAddresses Property (IPInfo Class)

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

Syntax

public String getAdapterOtherIPAddresses();

Default Value

""

Remarks

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

Note: This functionality is only available in Windows.

This property is read-only.

AdapterPhysicalAddress Property (IPInfo Class)

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

Syntax

public String getAdapterPhysicalAddress();

Default Value

""

Remarks

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

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

This property is read-only.

AdapterPrimaryWINSServer Property (IPInfo Class)

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

Syntax

public String getAdapterPrimaryWINSServer();

Default Value

""

Remarks

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

Note: This functionality is only available in Windows.

This property is read-only.

AdapterSecondaryWINSServer Property (IPInfo Class)

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

Syntax

public String getAdapterSecondaryWINSServer();

Default Value

""

Remarks

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

Note: This functionality is only available in Windows.

This property is read-only.

AdapterStatus Property (IPInfo Class)

This property returns the current status of the adapter.

Syntax

public String getAdapterStatus();

Default Value

""

Remarks

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

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.

AdapterSubnetMask Property (IPInfo Class)

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

Syntax

public String getAdapterSubnetMask();

Default Value

""

Remarks

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

This property is read-only.

AdapterType Property (IPInfo Class)

This property includes the type of adapter identified by AdapterIndex .

Syntax

public String getAdapterType();

Default Value

""

Remarks

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

Possible values include the following:

Possible values include the following (Unix OS):

This property is read-only.

AdapterUsesWINS Property (IPInfo Class)

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

Syntax

public boolean isAdapterUsesWINS();

Default Value

False

Remarks

This property indicates whether or not the adapter identified by AdapterIndex 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.

ARPProxy Property (IPInfo Class)

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

Syntax

public boolean isARPProxy();

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.

DHCPScope Property (IPInfo Class)

This property includes the DHCP scope of the DHCP server.

Syntax

public String getDHCPScope();

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.

DNSEnabled Property (IPInfo Class)

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

Syntax

public boolean isDNSEnabled();

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.

DNSServer Property (IPInfo Class)

This property includes the address of the DNS server.

Syntax

public String getDNSServer();

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.

DomainName Property (IPInfo Class)

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

Syntax

public String getDomainName();

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.

HostAddress Property (IPInfo Class)

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

Syntax

public String getHostAddress();
public void setHostAddress(String hostAddress);

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 HostName

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

The RequestComplete event is fired when the search is complete. The RequestId 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

HostAliases Property (IPInfo Class)

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

Syntax

public String getHostAliases();

Default Value

""

Remarks

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

This property is read-only.

HostName Property (IPInfo Class)

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

Syntax

public String getHostName();
public void setHostName(String hostName);

Default Value

""

Remarks

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

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

The RequestComplete event is fired when the search is complete. The RequestId property identifies the pending request.

Example. Resolve a Name:

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

LocalHost Property (IPInfo Class)

This property includes the name of the local host.

Syntax

public String getLocalHost();

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.

NodeType Property (IPInfo Class)

This property includes the type of node for the system.

Syntax

public String getNodeType();

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.

OtherAddresses Property (IPInfo Class)

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

Syntax

public String getOtherAddresses();

Default Value

""

Remarks

This property contains a list of alternate addresses for the host specified by HostName and HostAddress 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.

OtherDNSServers Property (IPInfo Class)

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

Syntax

public String getOtherDNSServers();

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 DNSServer property.

Note: This functionality is only available in Windows.

This property is read-only and not available at design time.

PendingRequests Property (IPInfo Class)

This property includes the number of requests awaiting completion.

Syntax

public int getPendingRequests();
public void setPendingRequests(int pendingRequests);

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 PendingRequests to 0.

Note: This functionality is only available in Windows.

RequestId Property (IPInfo Class)

This property includes the handle of the last request.

Syntax

public int getRequestId();

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 RequestComplete event is fired.

Note: This functionality is only available in Windows.

This property is read-only.

RoutingEnabled Property (IPInfo Class)

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

Syntax

public boolean isRoutingEnabled();

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 and not available at design time.

Config Method (IPInfo Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

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.

DHCPRelease Method (IPInfo Class)

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

Syntax

public void DHCPRelease();

Remarks

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

Note: This functionality is only available in Windows.

DHCPRenew Method (IPInfo Class)

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

Syntax

public void DHCPRenew();

Remarks

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

Note: This functionality is only available in Windows.

DisplayDNSCache Method (IPInfo Class)

This method displays cached DNS entries.

Syntax

public String displayDNSCache();

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

DoEvents Method (IPInfo Class)

This method processes events from the internal message queue.

Syntax

public void doEvents();

Remarks

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

FlushDNSCache Method (IPInfo Class)

This method flushes the DNS cache.

Syntax

public boolean flushDNSCache();

Remarks

This method flushes the DNS cache for the system.

Note: This functionality is only available in Windows.

GetMAC Method (IPInfo Class)

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

Syntax

public String getMAC(String IPAddress);

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 (IPInfo Class)

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

Syntax

public void reset();

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.

ResolveAddress Method (IPInfo Class)

This method resolves an IP address.

Syntax

public String resolveAddress(String hostAddress);

Remarks

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

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

Example. Resolve an Address:

String hostname = IPInfoControl.ResolveAddress("10.0.1.10");

ResolveName Method (IPInfo Class)

This method resolves a host name.

Syntax

public String resolveName(String hostName);

Remarks

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

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

Example. Resolve a Name:

String ipaddress = IPInfoControl.ResolveName("MyHostName");

DNSCacheEntry Event (IPInfo Class)

This event fires once for each cached DNS entry.

Syntax

public class DefaultIPInfoEventListener implements IPInfoEventListener {
  ...
  public void DNSCacheEntry(IPInfoDNSCacheEntryEvent e) {}
  ...
}

public class IPInfoDNSCacheEntryEvent {
  public String recordName;
  public int recordType;
  public int timeToLive;
  public int dataLength;
  public String section;
  public String recordValue;
  public String recordInfo;
}

Remarks

This event fires once for each entry in the local DNS cache when DisplayDNSCache 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.

Error Event (IPInfo Class)

Fired when information is available about errors during data delivery.

Syntax

public class DefaultIPInfoEventListener implements IPInfoEventListener {
  ...
  public void error(IPInfoErrorEvent e) {}
  ...
}

public class IPInfoErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception.

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.

RequestComplete Event (IPInfo Class)

This event is fired after an asynchronous request completes.

Syntax

public class DefaultIPInfoEventListener implements IPInfoEventListener {
  ...
  public void requestComplete(IPInfoRequestCompleteEvent e) {}
  ...
}

public class IPInfoRequestCompleteEvent {
  public int requestId;
  public int statusCode;
  public String description;
}

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, HostName, HostAddress, HostAliases, and OtherAddresses 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.

Config Settings (IPInfo Class)

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

Trappable Errors (IPInfo Class)

IPInfo Errors

SSL Errors

TCP/IP Errors