RequestETag Property
The request ETag.
Syntax
coap.getRequestETag([callback]) coap.setRequestETag( requestETag_Buffer, [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 getRequestETag([callback]) method is defined as:
function(err, buffer){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'buffer' is the value returned by the method.
The callback for the setRequestETag([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
When the class is operating in client mode (i.e., the Listening property is disabled), this property specifies the ETag that should be included in outgoing requests. Leave it empty to prevent an Etag option from being included.
When the class is operating in server mode (i.e., the Listening property is enabled), this property is populated with the ETag included in incoming requests (if any) anytime the Request event fires. It will be empty if an Etag option was not included.
This property is not available at design time.
Data Type
Buffer