RUI3 (RAK Unified Interface 3) - RAK4631
bg77::qcoapheader

Public Member Functions

String set (int, int, int)
 
String set (int, int, int, int, String)
 

Member Function Documentation

◆ set() [1/2]

String set ( int  ,
int  ,
int   
)
Description
This api configures the header of a CoAP message
Syntax
bg77.qcoapheader.set(clientID,msgID,mode)
Parameters
clientIDint Integer type. CoAP client identifier. Range: 0–5
msgIDint 16-bit unsigned integer in network byte order. Message ID. Used to detect message duplication and to match messages of type Acknowledgement/Reset to messages of type Confirmable/Non-confirmable. Range: 0–65535.
modeint Integer type. Whether to generate token value automatically.
  • 0 Do not generate token value automatically.
  • 1 Generate token value automatically.
Returns
String response

◆ set() [2/2]

String set ( int  ,
int  ,
int  ,
int  ,
String   
)
Description
This api configures the header of a CoAP message
Syntax
bg77.qcoapheader.set(clientID,msgID,mode,TKL,token)
Parameters
clientIDint Integer type. CoAP client identifier. Range: 0–5
msgIDint 16-bit unsigned integer in network byte order. Message ID. Used to detect message duplication and to match messages of type Acknowledgement/Reset to messages of type Confirmable/Non-confirmable. Range: 0–65535.
modeint Integer type. Whether to generate token value automatically.
  • 0 Do not generate token value automatically.
  • 1 Generate token value automatically.
TKLint 4-bit unsigned integer. The length of the variable-length <token> field. Range: 0–8. Unit: bytes. Only valid when <mode>=0.
tokenString Hex string type. Token value of CoAP message. Only valid when <mode>=0.
Returns
String response