PingResponseTime Property

Returned after calling the Ping method.

Syntax

 fdmsregister.getPingResponseTime([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 getPingResponseTime([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 setPingResponseTime([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

The PingResponseTime contains the total transaction time, in milliseconds, it took for the transaction to reach the Datawire server identified by the URL passed to the Ping method. This time includes only the time the transaction spent between pinged Datawire server and the FDMS host. This property is filled after calling the Ping method. For instance:

  FDMSRegister.ServiceDiscovery("https://staging1.datawire.net/sd")
  For i = 0 To FDMSRegister.ServiceProvidersCount - 1
    FDMSRegister.Ping(FDMSRegister.ServiceProviders[i])
    Debug.Print(FDMSRegister.ServiceProviders[i] & " = " & FDMSRegister.PingResponseTime)
  Next

Note: This property does not apply to Rapid Connect implementations.

This property is read-only.

Data Type

Long