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

Represents the OTA control interface functions. More...

#include <ota_interface_private.h>

Data Fields

OtaErr_t(* requestJob )(OtaAgentContext_t *pAgentCtx)
 
OtaErr_t(* updateJobStatus )(OtaAgentContext_t *pAgentCtx, OtaJobStatus_t status, int32_t reason, int32_t subReason)
 
OtaErr_t(* cleanup )(const OtaAgentContext_t *pAgentCtx)
 

Detailed Description

Represents the OTA control interface functions.

The functions in this structure are used for the control operations during over the air updates like OTA job status updates.

Field Documentation

◆ requestJob

OtaErr_t( * OtaControlInterface_t::requestJob) (OtaAgentContext_t *pAgentCtx)

Request for the next available OTA job from the job service.

◆ updateJobStatus

OtaErr_t( * OtaControlInterface_t::updateJobStatus) (OtaAgentContext_t *pAgentCtx, OtaJobStatus_t status, int32_t reason, int32_t subReason)

Updates the OTA job status with information like in progress, completion, or failure.

◆ cleanup

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

Cleanup related to OTA control plane.


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