DNS Class

Properties   Methods   Events   Config Settings   Errors  

The DNS class is used to query DNS for record information.

Class Name

IPWorks_DNS

Procedural Interface

 ipworks_dns_open();
 ipworks_dns_close($res);
 ipworks_dns_register_callback($res, $id, $function);
 ipworks_dns_get_last_error($res);
 ipworks_dns_get_last_error_code($res);
 ipworks_dns_set($res, $id, $index, $value);
 ipworks_dns_get($res, $id, $index);
 ipworks_dns_do_config($res, $configurationstring);
 ipworks_dns_do_doevents($res);
 ipworks_dns_do_getfieldvalue($res, $recordindex, $fieldname);
 ipworks_dns_do_interrupt($res);
 ipworks_dns_do_query($res, $domain);
 ipworks_dns_do_reset($res);

Remarks

The DNS class queries a DNS server for records as specified in RFC 1035 and other relevant RFCs. The class property QueryType indicates the record to be queried. Calling Query will initiate the query.

Once the query is complete, a single Response event will fire and the record properties will be filled. StatusCode is the server's success or fail code, and Status is a standard string interpretation of the code.

The records are contained in the Records properties. The programming interface is designed to allow a full walk of the records in the DNS response, including provisions for handling new record types.

The class operates synchronously by default (i.e., it waits for a response before returning control to the caller); however, the class also may operate asynchronously (i.e., return control immediately), by setting Timeout to 0. Please see the Timeout property for more information.

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.

DNSPort Property (IPWorks_DNS Class)

This is the port to connect to on the DNS server.

Object Oriented Interface

public function getDNSPort();
public function setDNSPort($value);

Procedural Interface

ipworks_dns_get($res, 1 );
ipworks_dns_set($res, 1, $value );

Default Value

53

Remarks

This property contains the port to connect to on the DNS server. A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

This property is not available at design time.

Data Type

Integer

DNSServer Property (IPWorks_DNS Class)

This is the address of the DNS server.

Object Oriented Interface

public function getDNSServer();
public function setDNSServer($value);

Procedural Interface

ipworks_dns_get($res, 2 );
ipworks_dns_set($res, 2, $value );

Default Value

''

Remarks

This property contains the address of the DNS server. The class attempts to find the default DNS server for the machine where it is installed, and provide it in the DNSServer property. You may change it to any particular DNS server you want to query. While any internet host running a DNS service will suffice, it is preferable to use either the DNS server for your network or the DNS server for the domain that you are querying.

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

Note: Automatic discovery of the default DNS server is not supported in the Java edition.

This property is not available at design time.

Data Type

String

Idle Property (IPWorks_DNS Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

ipworks_dns_get($res, 3 );

Default Value

true

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LocalHost Property (IPWorks_DNS Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

ipworks_dns_get($res, 4 );
ipworks_dns_set($res, 4, $value );

Default Value

''

Remarks

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

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

Protocol Property (IPWorks_DNS Class)

This protocol is used for the DNS request.

Object Oriented Interface

public function getProtocol();
public function setProtocol($value);

Procedural Interface

ipworks_dns_get($res, 5 );
ipworks_dns_set($res, 5, $value );

Default Value

0

Remarks

This property specifies the protocol used for the DNS request when Query is called. Possible values include the following:

Data Type

Integer

QueryType Property (IPWorks_DNS Class)

This is the type of record to query.

Object Oriented Interface

public function getQueryType();
public function setQueryType($value);

Procedural Interface

ipworks_dns_get($res, 6 );
ipworks_dns_set($res, 6, $value );

Default Value

1

Remarks

Before a query is attempted, this property must be set to the desired record type. The records are defined as follows:

This property is not available at design time.

Data Type

Integer

RecordCount Property (IPWorks_DNS Class)

The number of records in the Record arrays.

Object Oriented Interface

public function getRecordCount();

Procedural Interface

ipworks_dns_get($res, 7 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• RecordData
• RecordDomain
• RecordFieldCount
• RecordFieldIndex
• RecordFieldName
• RecordFieldValue
• RecordTTL
• RecordType
• RecordTypeName

The array indices start at 0 and end at RecordCount - 1.

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

Data Type

Integer

RecordDomain Property (IPWorks_DNS Class)

This property contains the domain name associated with the selected response record, at RecordIndex .

Object Oriented Interface

public function getRecordDomain($recordindex);

Procedural Interface

ipworks_dns_get($res, 8 , $recordindex);

Default Value

''

Remarks

This property contains the domain name associated with the selected response record, at RecordIndex.

The $recordindex parameter specifies the index of the item in the array. The size of the array is controlled by the RecordCount property.

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

Data Type

String

RecordFieldCount Property (IPWorks_DNS Class)

This property contains the number of properties in the current record.

Object Oriented Interface

public function getRecordFieldCount($recordindex);

Procedural Interface

ipworks_dns_get($res, 9 , $recordindex);

Default Value

0

Remarks

This property contains the number of properties in the current record.

After a successful query, the field values for each record will be provided in the Records properties.

To retrieve a particular field value for a record, first set RecordFieldIndex to a valid response field index and then query records collection for the value of that field.

The $recordindex parameter specifies the index of the item in the array. The size of the array is controlled by the RecordCount property.

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

Data Type

Integer

RecordFieldIndex Property (IPWorks_DNS Class)

This property contains the index of the selected property of the current record.

Object Oriented Interface

public function getRecordFieldIndex($recordindex);
public function setRecordFieldIndex($recordindex, $value);

Procedural Interface

ipworks_dns_get($res, 10 , $recordindex);
ipworks_dns_set($res, 10, $value , $recordindex);

Default Value

1

Remarks

This property contains the index of the selected property of the current record. RecordFieldIndex valid values are from 0 to (RecordFieldCount -1).

After a successful query, the field values for each record will be provided in the Records properties.

To retrieve a particular field value for a record, first set RecordFieldIndex to a valid response field index and then query records collection for the value of that field.

The $recordindex parameter specifies the index of the item in the array. The size of the array is controlled by the RecordCount property.

This property is not available at design time.

Data Type

Integer

RecordFieldName Property (IPWorks_DNS Class)

This property contains the name of the property selected by FieldIndex .

Object Oriented Interface

public function getRecordFieldName($recordindex);

Procedural Interface

ipworks_dns_get($res, 11 , $recordindex);

Default Value

'0'

Remarks

This property contains the name of the field selected by RecordFieldIndex. Field names are different depending on the record type. For example, an MX record type will contain two properties: PREFERENCE and EXCHANGE, but an SOA record type contains seven properties.

Field names:

The $recordindex parameter specifies the index of the item in the array. The size of the array is controlled by the RecordCount property.

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

Data Type

String

RecordFieldValue Property (IPWorks_DNS Class)

This property contains the value of the property selected by FieldIndex .

Object Oriented Interface

public function getRecordFieldValue($recordindex);

Procedural Interface

ipworks_dns_get($res, 12 , $recordindex);

Default Value

''

Remarks

This property contains the value of the field selected by RecordFieldIndex.

After a successful query, the field values for each record will be provided in the Records properties.

To retrieve a particular field value for a record, first set RecordFieldIndex to a valid response field index and then query records collection for the value of that field.

The $recordindex parameter specifies the index of the item in the array. The size of the array is controlled by the RecordCount property.

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

Data Type

Binary String

RecordData Property (IPWorks_DNS Class)

This property contains the full record data as received from the DNS server.

Object Oriented Interface

public function getRecordData($recordindex);

Procedural Interface

ipworks_dns_get($res, 13 , $recordindex);

Default Value

''

Remarks

This property contains the full record data as received from the DNS server.

After a successful query, the field values for each record will be provided in the Records properties.

To retrieve a particular field value for a record, first set RecordFieldIndex to a valid response field index and then query records collection for the value of that field.

The $recordindex parameter specifies the index of the item in the array. The size of the array is controlled by the RecordCount property.

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

Data Type

Binary String

RecordType Property (IPWorks_DNS Class)

This property contains the record type.

Object Oriented Interface

public function getRecordType($recordindex);

Procedural Interface

ipworks_dns_get($res, 14 , $recordindex);

Default Value

1

Remarks

This property contains the record type.

Record types correspond to QueryType and are defined as follows:

The $recordindex parameter specifies the index of the item in the array. The size of the array is controlled by the RecordCount property.

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

Data Type

Integer

RecordTypeName Property (IPWorks_DNS Class)

This property contains the string representation of the current record type defined by RecordType .

Object Oriented Interface

public function getRecordTypeName($recordindex);

Procedural Interface

ipworks_dns_get($res, 15 , $recordindex);

Default Value

''

Remarks

This property contains the string representation of the current record type defined by RecordType.

The $recordindex parameter specifies the index of the item in the array. The size of the array is controlled by the RecordCount property.

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

Data Type

String

RecordTTL Property (IPWorks_DNS Class)

This property contains the record Time to Live (TTL) value.

Object Oriented Interface

public function getRecordTTL($recordindex);

Procedural Interface

ipworks_dns_get($res, 16 , $recordindex);

Default Value

0

Remarks

This property contains the record Time to Live (TTL) value. The TTL specifies the time interval in seconds that the record is valid, or the time interval that the record can be cached before the DNS server should be queried again.

The $recordindex parameter specifies the index of the item in the array. The size of the array is controlled by the RecordCount property.

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

Data Type

Integer

RecordSource Property (IPWorks_DNS Class)

The source of records provided in the Records properties.

Object Oriented Interface

public function getRecordSource();
public function setRecordSource($value);

Procedural Interface

ipworks_dns_get($res, 17 );
ipworks_dns_set($res, 17, $value );

Default Value

0

Remarks

This property contains the source of records provided in the Records properties and can have one of the following values:

This property is not available at design time.

Data Type

Integer

Recursive Property (IPWorks_DNS Class)

This determines whether to ask the DNSServer to recursively query other servers.

Object Oriented Interface

public function getRecursive();
public function setRecursive($value);

Procedural Interface

ipworks_dns_get($res, 18 );
ipworks_dns_set($res, 18, $value );

Default Value

true

Remarks

If this property is True, the component will tell the DNS server to perform the query recursively. This means that if the DNS server does not have information about the domain being queried, it will send the request to another DNS server.

This property is not available at design time.

Data Type

Boolean

RequestId Property (IPWorks_DNS Class)

This is the Id of the current DNS request.

Object Oriented Interface

public function getRequestId();
public function setRequestId($value);

Procedural Interface

ipworks_dns_get($res, 19 );
ipworks_dns_set($res, 19, $value );

Default Value

1

Remarks

This property is the identifier of the request that generated the current response values. Each time the class makes a DNS query, it generates a unique request identifier to track the response.

If a custom value is needed for RequestId, the property must be set before sending a request. The class increments RequestId automatically after sending each request.

Note: The class fails with an error when a value that is not between 1 and 32,767 is specified.

This property is not available at design time.

Data Type

Integer

Status Property (IPWorks_DNS Class)

This is a standard string interpretation of StatusCode .

Object Oriented Interface

public function getStatus();

Procedural Interface

ipworks_dns_get($res, 20 );

Default Value

''

Remarks

This property contains a standard string interpretation of StatusCode. For a list of valid error codes and their descriptions, please see the Error Codes section.

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

Data Type

String

StatusCode Property (IPWorks_DNS Class)

This contains the success or error code for the DNS query.

Object Oriented Interface

public function getStatusCode();

Procedural Interface

ipworks_dns_get($res, 21 );

Default Value

0

Remarks

This property contains the success or error code for the DNS query. For a list of valid error codes and their descriptions, please see the Error Codes section.

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

Data Type

Integer

Timeout Property (IPWorks_DNS Class)

This property includes the timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

ipworks_dns_get($res, 22 );
ipworks_dns_set($res, 22, $value );

Default Value

60

Remarks

If the Timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If Timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

Config Method (IPWorks_DNS Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworks_dns_do_config($res, $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.

DoEvents Method (IPWorks_DNS Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworks_dns_do_doevents($res);

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.

GetFieldValue Method (IPWorks_DNS Class)

This gets the value of the field indicated from a record.

Object Oriented Interface

public function doGetFieldValue($recordindex, $fieldname);

Procedural Interface

ipworks_dns_do_getfieldvalue($res, $recordindex, $fieldname);

Remarks

This method will get the value of the DNS record field specified by FieldName from the DNS record at RecordIndex. If no such field exists for that record type, the component fails with an error.

Interrupt Method (IPWorks_DNS Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworks_dns_do_interrupt($res);

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

Query Method (IPWorks_DNS Class)

This method queries a domain.

Object Oriented Interface

public function doQuery($domain);

Procedural Interface

ipworks_dns_do_query($res, $domain);

Remarks

This method will query the host Domain for any records of the type in QueryType. After the query, RequestId is the identifier corresponding to the request. Once the query is complete, a single Response event will fire. The following properties will contain the results:

Reset Method (IPWorks_DNS Class)

This method will reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworks_dns_do_reset($res);

Remarks

This method will reset the class's properties to their default values.

Error Event (IPWorks_DNS Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworks_dns_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

Log Event (IPWorks_DNS Class)

This event fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworks_dns_register_callback($res, 2, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

Response Event (IPWorks_DNS Class)

This event fires after a DNS query.

Object Oriented Interface

public function fireResponse($param);

Procedural Interface

ipworks_dns_register_callback($res, 3, array($this, 'fireResponse'));

Parameter List

 'requestid'
 'domain'
 'statuscode'
 'description'
 'authoritative'

Remarks

The Response event will fire after a call to Query. The RequestId parameter contains the request Id associated with the original query. Domain is the domain of the query. The Authoritative parameter is true if the response is from an authoritative name server. If there is an error returned by the server, StatusCode and Description provide them.

Once the query is complete, a single Response event will fire. The following properties will contain the results:

SSLServerAuthentication Event (IPWorks_DNS Class)

This event fires when connecting to the server.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworks_dns_register_callback($res, 4, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'remoteaddress'
 'remoteport'
 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

This event allows the client to decide whether or not to continue with the connection process. The Accept parameter recommends whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If the client decides to continue, you can override and accept the certificate by setting the Accept parameter to True.

RemoteAddress is the IP address of the server.

RemotePort is the source port of the server.

CertEncoded is the Base64-encoded certificate presented by the server.

CertSubject is the subject of the certificate presented by the server.

CertIssuer is the subject of the issuer of the certificate presented by the server.

Status is the status of the certificate.

Accept defines whether the certificate is accepted.

SSLStatus Event (IPWorks_DNS Class)

This shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworks_dns_register_callback($res, 5, array($this, 'fireSSLStatus'));

Parameter List

 'remoteaddress'
 'remoteport'
 'message'

Remarks

The event is fired for informational and logging purposes only. It is used to track the progress of the connection.

RemoteAddress is the IP address of the remote machine.

RemotePort is the port of the remote machine.

Message is the log message.

Config Settings (DNS 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.

DNS Config Settings

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (DNS Class)

DNS Errors

The class may also return one of the following error codes, which are inherited from other classes.

UDP Errors

SSL Errors

TCP/IP Errors