Protocol Property

The protocol used for the DNS request.

Syntax

 dns.getProtocol([callback])
 dns.setProtocol( protocol, [callback])

Possible Values

  0 (ptUDP), 
  1 (ptTCP), 
  2 (ptTLS), 
  3 (ptHTTPS)

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getProtocol([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setProtocol([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

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

0 (ptUDP - default) UDP is used. This is the most commonly used DNS protocol.
1 (ptTCP) TCP is used.
2 (ptTLS) TCP with TLS is used. Set DNSPort to the port which the server uses for TLS connections. Typically this is port 853.
3 (ptHTTPS) HTTP is used. The DNS request is made over HTTP. DNSServer must bet set to a URL of a server accepting DNS over HTTPS (DoH) requests. See the DoHMethod configuration setting for additional options when using this protocol.

Data Type

Integer

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 Node.js Edition - Version 20.0 [Build 8307]