JSON document model to store the details of parameters expected in the job document. More...
#include <ota_private.h>
Data Fields | |
void * | contextBase |
uint32_t | contextSize |
const JsonDocParam_t * | pBodyDef |
uint16_t | numModelParams |
uint32_t | paramsReceivedBitmap |
uint32_t | paramsRequiredBitmap |
JSON document model to store the details of parameters expected in the job document.
The document model is currently limited to 32 parameters per the implementation, although it may be easily expanded to more in the future by simply expanding the parameter bitmap.
The document model is used to control what JSON parameters are expected from a document and where to store the parameters, if desired, in a destination context. We currently only store parameters into an OtaFileContext_t but it could be used for any structure since we don't use a type pointer.
void* JsonDocModel_t::contextBase |
The base address of the destination OTA context structure.
uint32_t JsonDocModel_t::contextSize |
The size, in bytes, of the destination context structure.
const JsonDocParam_t* JsonDocModel_t::pBodyDef |
Pointer to the document model body definition.
uint16_t JsonDocModel_t::numModelParams |
The number of entries in the document model (limited to 32).
uint32_t JsonDocModel_t::paramsReceivedBitmap |
Bitmap of the parameters received based on the model.
uint32_t JsonDocModel_t::paramsRequiredBitmap |
Bitmap of the parameters required from the model.