RequestId Property

The ID of the current DNS request.

Syntax

 dns.getRequestId([callback])
 dns.setRequestId( requestId, [callback])

Default Value

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 getRequestId([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 setRequestId([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 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