Protocol Property

The protocol used by the component.

Syntax

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

Possible Values

  0 (tpTime), 
  1 (tpSNTP)

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 is the protocol used by the component. Use this property to specify which protocol the class will use to connect to the server. By default, this property is tpTimeProtocol (0). The SNTP protocol may be selected by setting this property to tpSNTP (1).

Data Type

Integer