DNS Module

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

IPWorks.DNS

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 module with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

DNSPort Property (DNS Module)

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

Syntax

• Swift
• Objective-C

public var dnsPort: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=DNSPort,setter=setDNSPort:) int DNSPort;

- (int)DNSPort;
- (void)setDNSPort :(int)newDNSPort;

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.

DNSServer Property (DNS Module)

This is the address of the DNS server.

Syntax

• Swift
• Objective-C

public var dnsServer: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=DNSServer,setter=setDNSServer:) NSString* DNSServer;

- (NSString*)DNSServer;
- (void)setDNSServer :(NSString*)newDNSServer;

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.

Idle Property (DNS Module)

The current status of the module.

Syntax

• Swift
• Objective-C

public var idle: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=idle) BOOL idle;

- (BOOL)idle;

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.

LocalHost Property (DNS Module)

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

Syntax

• Swift
• Objective-C

public var localHost: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost;

- (NSString*)localHost;
- (void)setLocalHost :(NSString*)newLocalHost;

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.

Protocol Property (DNS Module)

This protocol is used for the DNS request.

Syntax

• Swift
• Objective-C

public var protocol_: DNSProtocols {
  get {...}
  set {...}
}

public enum DNSProtocols: Int32 {
  case ptUDP = 0
  case ptTCP = 1
  case ptTLS = 2
  case ptHTTPS = 3
}

@property (nonatomic,readwrite,assign,getter=protocol,setter=setProtocol:) int protocol;

- (int)protocol;
- (int)protocol_;
- (void)setProtocol :(int)newProtocol;
- (void)setProtocol_ :(int)newProtocol;

Default Value

0

Remarks

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

QueryType Property (DNS Module)

This is the type of record to query.

Syntax

• Swift
• Objective-C

public var queryType: DNSQueryTypes {
  get {...}
  set {...}
}

public enum DNSQueryTypes: Int32 {
  case qtAddress = 1
  case qtNS = 2
  case qtMD = 3
  case qtMF = 4
  case qtCName = 5
  case qtSOA = 6
  case qtMailBox = 7
  case qtMailGroup = 8
  case qtMR = 9
  case qtNULL = 10
  case qtWKS = 11
  case qtPointer = 12
  case qtHostInfo = 13
  case qtMailInfo = 14
  case qtMX = 15
  case qtText = 16
  case qtRP = 17
  case qtAFSDB = 18
  case qtX25 = 19
  case qtISDN = 20
  case qtRT = 21
  case qtAAAA = 28
  case qtSRV = 33
  case qtNAPTR = 35
  case qtCERT = 37
  case qtRevLookup = 100
}

@property (nonatomic,readwrite,assign,getter=queryType,setter=setQueryType:) int queryType;

- (int)queryType;
- (void)setQueryType :(int)newQueryType;

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:

Records Property (DNS Module)

This is the collection of records in the last response.

Syntax

• Swift
• Objective-C

public var records: Array<DNSRecord> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=recordCount) int recordCount;

- (int)recordCount;

- (NSString*)recordDomain:(int)recordIndex;

- (int)recordFieldCount:(int)recordIndex;

- (int)recordFieldIndex:(int)recordIndex;
- (void)setRecordFieldIndex:(int)recordIndex :(int)newRecordFieldIndex;

- (NSString*)recordFieldName:(int)recordIndex;

- (NSString*)recordFieldValue:(int)recordIndex;

- (NSData*)recordFieldValueB:(int)recordIndex;
- (NSString*)recordData:(int)recordIndex;

- (NSData*)recordDataB:(int)recordIndex;
- (int)recordType:(int)recordIndex;

- (NSString*)recordTypeName:(int)recordIndex;

- (int)recordTTL:(int)recordIndex;

Default Value

60

Remarks

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

Example (loop through all fields of all records)

For i = 0 to DNSControl.RecordsCount - 1 For j = 0 to DNSControl.RecordFieldCount(i) - 1 DNSControl.Records(i).RecordFieldIndex(i) = j DoSomethingWith(DNSControl.RecordFieldName(i), DNSControl.RecordFieldValue(i)) Next j Next i

RecordSource Property (DNS Module)

The source of records provided in the Records properties.

Syntax

• Swift
• Objective-C

public var recordSource: DNSRecordSources {
  get {...}
  set {...}
}

public enum DNSRecordSources: Int32 {
  case rsAnswerSection = 0
  case rsNameServerSection = 1
  case rsAdditionalRecordsSection = 2
}

@property (nonatomic,readwrite,assign,getter=recordSource,setter=setRecordSource:) int recordSource;

- (int)recordSource;
- (void)setRecordSource :(int)newRecordSource;

Default Value

0

Remarks

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

Recursive Property (DNS Module)

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

Syntax

• Swift
• Objective-C

public var recursive: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=recursive,setter=setRecursive:) BOOL recursive;

- (BOOL)recursive;
- (void)setRecursive :(BOOL)newRecursive;

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.

RequestId Property (DNS Module)

This is the Id of the current DNS request.

Syntax

• Swift
• Objective-C

public var requestId: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=requestId,setter=setRequestId:) int requestId;

- (int)requestId;
- (void)setRequestId :(int)newRequestId;

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 when a value that is not between 1 and 32,767 is specified.

Status Property (DNS Module)

This is a standard string interpretation of StatusCode .

Syntax

• Swift
• Objective-C

public var status: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=status) NSString* status;

- (NSString*)status;

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.

StatusCode Property (DNS Module)

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

Syntax

• Swift
• Objective-C

public var statusCode: Int32 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=statusCode) int statusCode;

- (int)statusCode;

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.

Timeout Property (DNS Module)

This property includes the timeout for the module.

Syntax

• Swift
• Objective-C

public var timeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;

- (int)timeout;
- (void)setTimeout :(int)newTimeout;

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 .

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.

Config Method (DNS Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)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 (DNS Module)

This method processes events from the internal message queue.

Syntax

• Swift
• Objective-C

public func doEvents() throws -> Void

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

GetFieldValue Method (DNS Module)

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

Syntax

• Swift
• Objective-C

public func getFieldValue(recordIndex: Int32, fieldName: String) throws -> String

- (NSString*)getFieldValue:(int)recordIndex :(NSString*)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 .

Interrupt Method (DNS Module)

This method interrupts the current method.

Syntax

• Swift
• Objective-C

public func interrupt() throws -> Void

- (void)interrupt;

Remarks

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

Query Method (DNS Module)

This method queries a domain.

Syntax

• Swift
• Objective-C

public func query(domain: String) throws -> Void

- (void)query:(NSString*)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 (DNS Module)

This method will reset the component.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

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

Error Event (DNS Module)

Fired when information is available about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

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

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 (DNS Module)

This event fires once for each log message.

Syntax

• Swift
• Objective-C

func onLog(logLevel: Int32, message: String, logType: String)

- (void)onLog:(int)logLevel :(NSString*)message :(NSString*)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 (DNS Module)

This event fires after a DNS query.

Syntax

• Swift
• Objective-C

func onResponse(requestId: Int32, domain: String, statusCode: Int32, description: String, authoritative: Bool)

- (void)onResponse:(int)requestId :(NSString*)domain :(int)statusCode :(NSString*)description :(BOOL)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 (DNS Module)

This event fires when connecting to the server.

Syntax

• Swift
• Objective-C

func onSSLServerAuthentication(remoteAddress: String, remotePort: Int32, certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)

- (void)onSSLServerAuthentication:(NSString*)remoteAddress :(int)remotePort :(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)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 (DNS Module)

This shows the progress of the secure connection.

Syntax

• Swift
• Objective-C

func onSSLStatus(remoteAddress: String, remotePort: Int32, message: String)

- (void)onSSLStatus:(NSString*)remoteAddress :(int)remotePort :(NSString*)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.

DNSRecord Type

This is a record that is returned by the DNS server.

Remarks

When a Query method is performed by the DNS class, the DNS server returns one or more DNSRecords containing information about the domain you specified. This information is contained in the different fields of the record.

Each record may have multiple FieldNames and corresponding FieldValues. You may iterate through these by setting the FieldIndex field.

Fields

Constructors

public init()

Config Settings (DNS Module)

DNS Config Settings

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (DNS Module)

DNS Errors

UDP Errors

SSL Errors

TCP/IP Errors