AWS IoT Over-the-air Update  v3.0.0
Client library for AWS IoT OTA
OtaDataInterface_t Struct Reference

Represents the OTA data interface functions. More...

#include <ota_interface_private.h>

Data Fields

OtaErr_t(* initFileTransfer )(OtaAgentContext_t *pAgentCtx)
 
OtaErr_t(* requestFileBlock )(OtaAgentContext_t *pAgentCtx)
 
OtaErr_t(* decodeFileBlock )(const uint8_t *pMessageBuffer, size_t messageSize, int32_t *pFileId, int32_t *pBlockId, int32_t *pBlockSize, uint8_t **pPayload, size_t *pPayloadSize)
 
OtaErr_t(* cleanup )(const OtaAgentContext_t *pAgentCtx)
 

Detailed Description

Represents the OTA data interface functions.

The functions in this structure are used for the data operations during over the air updates like requesting file blocks.

Field Documentation

◆ initFileTransfer

OtaErr_t( * OtaDataInterface_t::initFileTransfer) (OtaAgentContext_t *pAgentCtx)

Initialize file transfer.

◆ requestFileBlock

OtaErr_t( * OtaDataInterface_t::requestFileBlock) (OtaAgentContext_t *pAgentCtx)

Request File block.

◆ decodeFileBlock

OtaErr_t( * OtaDataInterface_t::decodeFileBlock) (const uint8_t *pMessageBuffer, size_t messageSize, int32_t *pFileId, int32_t *pBlockId, int32_t *pBlockSize, uint8_t **pPayload, size_t *pPayloadSize)

Decode a cbor encoded fileblock.

◆ cleanup

OtaErr_t( * OtaDataInterface_t::cleanup) (const OtaAgentContext_t *pAgentCtx)

Cleanup related to OTA data plane.


The documentation for this struct was generated from the following file: