Dns Perl Reference Documentation

CkDns

Current Version: 10.1.2

API for managing DNS nameservers to be used by Chilkat, and for doing DNS queries.

Object Creation

$obj = chilkat::CkDns->new();

Properties

DebugLogFilePath
# $strVal is a string
# $ckStr is a CkString
$dns->get_DebugLogFilePath($ckStr);
$strVal = $dns->debugLogFilePath();
$dns->put_DebugLogFilePath($strVal);

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

More Information and Examples
top
LastErrorHtml
# $strVal is a string
# $ckStr is a CkString
$dns->get_LastErrorHtml($ckStr);
$strVal = $dns->lastErrorHtml();

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorText
# $strVal is a string
# $ckStr is a CkString
$dns->get_LastErrorText($ckStr);
$strVal = $dns->lastErrorText();

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorXml
# $strVal is a string
# $ckStr is a CkString
$dns->get_LastErrorXml($ckStr);
$strVal = $dns->lastErrorXml();

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastMethodSuccess
# $boolVal is a boolean
$boolVal = $dns->get_LastMethodSuccess();
$dns->put_LastMethodSuccess($boolVal);

Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

top
MaxWaitMs
# $intVal is an integer
$intVal = $dns->get_MaxWaitMs();
$dns->put_MaxWaitMs($intVal);
Introduced in version 9.5.0.96

The maxiumum number of milliseconds to wait for the answer to a DNS query. A value of 0 is to wait indefinitely (no timeout). It's not a good idea to specify 0 (infinite timeout) or a value less than 1000 (1 second). The default value is 10000 milliseconds.

top
NumNameservers
# $intVal is an integer
$intVal = $dns->get_NumNameservers();
Introduced in version 9.5.0.96

The number of nameservers currently being used by Chilkat for DNS queries in all objects/classes, such as for HTTP, Email, FTP, SSH, etc.

top
TlsPref
# $intVal is an integer
$intVal = $dns->get_TlsPref();
$dns->put_TlsPref($intVal);
Introduced in version 9.5.0.96

Specifies the TLS preference. Possible values are:

  • 0 = No TLS
  • 1 = Prefer TLS if possible.
  • 2 = Require TLS

The default value is 0. If TLS is preferred then DNS nameservers with TLS capability will be tried first. If none succeed, then UDP/TCP will be tried. If TLS is required, then only TLS capable nameservers will be tried and all DNS queries will use TLS.

Note: To use TLS, your application needs to first specify nameservers by calling AddNameserver once per nameserver with the supportsTls argument set to 1.

top
Utf8
# $boolVal is a boolean
$boolVal = $dns->get_Utf8();
$dns->put_Utf8($boolVal);

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

top
VerboseLogging
# $boolVal is a boolean
$boolVal = $dns->get_VerboseLogging();
$dns->put_VerboseLogging($boolVal);

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
# $strVal is a string
# $ckStr is a CkString
$dns->get_Version($ckStr);
$strVal = $dns->version();

Version of the component/library, such as "10.1.0"

More Information and Examples
top

Methods

AddDefaultNameservers
$dns->AddDefaultNameservers();
Introduced in version 9.5.0.96

Adds the default (auto-assigned) nameservers to the collection of nameservers used by Chilkat for DNS queries and domain to IP address lookups.

top
AddNameserver
# $ipAddr is a string
# $supportsTls is a boolean
$dns->AddNameserver($ipAddr, $supportsTls);
Introduced in version 9.5.0.96

Adds a new nameserver to the collection of nameservers used by Chilkat for DNS queries and domain to IP address lookups. The ipAddr specifies the IPv4 address of the nameserver. The supportsTls indicates if the namserver supports DoT (DNS over TLS. DoT uses port 853 for encrypted DNS communication.) If the TlsPreference property is set to 1 or 2, then Chilkat will use TLS nameservers.

top
GetNameserver
# $index is an integer
# $outStr is a CkString (output)
$status = $dns->GetNameserver($index, $outStr);
$retStr = $dns->getNameserver($index);
Introduced in version 9.5.0.96

Returns the IP address of the Nth nameserver currently used by Chilkat for DNS queries and domain to IP address lookups. The index specifies the index of the nameserver. The 1st nameserver is at index 0.

Returns 1 for success, 0 for failure.

More Information and Examples
top
Query
# $recordType is a string
# $domain is a string
# $answer is a CkJsonObject
$retBool = $dns->Query($recordType, $domain, $answer);
Introduced in version 9.5.0.96

Performs an DNS query for domain and returns the answer in answer. The type of DNS query is specified in recordType and can be A, AAAA, ALIAS, CAA, MX, NS, SOA, TXT. Additional record types can be added as needed.

top
QueryAsync (1)
# returns a CkTask
# $recordType is a string
# $domain is a string
# $answer is a CkJsonObject
$ret_task = $dns->QueryAsync($recordType, $domain, $answer);
Introduced in version 9.5.0.96

Creates an asynchronous task to call the Query method with the arguments provided.

Returns null on failure

top
RemoveAllNameservers
$dns->RemoveAllNameservers();
Introduced in version 9.5.0.96

Removes all nameservers from the collection of nameservers used by Chilkat. An application can call this method to reset to 0 nameservers before adding new nameservers. If a DNS domain to IP address resolution is needed by Chilkat, then the auto-assigned nameserver IP addresses will be automaticaly restored.

top
RemoveNameserver
# $ipAddr is a string
$dns->RemoveNameserver($ipAddr);
Introduced in version 9.5.0.96

Removes a nameserver from the collection of nameservers used by Chilkat. The ipAddr is the IPv4 address of the nameserver to be removed.

top