DNS Class
Properties Methods Events Configuration Settings Errors
The DNS class 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 collection. 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 (waits for a response before returning control to the caller), however, the class may also operate asynchronously (return control immediately), by setting Timeout to 0. Please refer to 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.
DNSPort | The port to connect to on the DNS Server. |
DNSServer | The address of the DNS server. |
Idle | The current status of the class. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
Protocol | The protocol used for the DNS request. |
QueryType | The record type to query. |
Records | Collection of records in the last response. |
RecordSource | The source of records provided in the Records properties. |
Recursive | Determines whether to ask the DNSServer to recursively query other servers. |
RequestId | The ID of the current DNS request. |
Status | A standard string interpretation of StatusCode . |
StatusCode | The success or error code for the DNS query. |
Timeout | A timeout for the class. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
DoEvents | Processes events from the internal message queue. |
GetFieldValue | Get the value of the field indicated from a record. |
Interrupt | Interrupt the current method. |
Query | Query a Domain. |
Reset | Reset the class. |
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.
Error | Information about errors during data delivery. |
Response | Fires after a DNS query. |
SSLServerAuthentication | Fires when connecting to the server. |
SSLStatus | Shows the progress of the secure connection. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
ConnectionMode | Sets the connection mode for the DNS query. |
DNSProtocolLog | Returns a 'nslookup' style log. |
DoHMethod | Specifies the DNS over HTTPS method. |
ResponseTruncated | Whether the response is truncated. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
CaptureIPPacketInfo | Used to capture the packet information. |
DestinationAddress | Used to get the destination address from the packet information. |
DontFragment | Used to set the Don't Fragment flag of outgoing packets. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxPacketSize | The maximum length of the packets that can be received. |
QOSDSCPValue | Used to specify an arbitrary QOS/DSCP setting (optional). |
QOSTrafficType | Used to specify QOS/DSCP settings (optional). |
ShareLocalPort | If set to True, allows more than one instance of the class to be active on the same local port. |
UseConnection | Determines whether to use a connected socket. |
UseIPv6 | Whether or not to use IPv6. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
GUIAvailable | Tells the class whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
UseDaemonThreads | Whether threads created by the class are daemon threads. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |