AWS IoT Over-the-air Update
v3.1.0
Client library for AWS IoT OTA
|
|
Go to the documentation of this file.
29 #ifndef OTA_OS_INTERFACE_H
30 #define OTA_OS_INTERFACE_H
77 struct OtaEventContext;
98 typedef enum OtaOsStatus
139 const void * pEventMsg,
140 unsigned int timeout );
202 const char *
const pTimerName,
203 const uint32_t timeout,
241 typedef void * ( * OtaMalloc_t ) (
size_t size );
261 typedef struct OtaEventInterface
274 typedef struct OtaTimerInterface
289 typedef struct OtaMallocInterface
304 typedef struct OtaOSInterface
Definition: ota_os_interface.h:262
OtaInitEvent_t init
Initialization event.
Definition: ota_os_interface.h:263
OtaReceiveEvent_t recv
Receive data.
Definition: ota_os_interface.h:265
@ OtaOsSuccess
OTA OS interface success.
Definition: ota_os_interface.h:100
struct OtaEventContext OtaEventContext_t
Type definition for Event Context.
Definition: ota_os_interface.h:82
OtaOsStatus_t(* OtaReceiveEvent_t)(OtaEventContext_t *pEventCtx, void *pEventMsg, uint32_t timeout)
Receive an OTA event.
Definition: ota_os_interface.h:156
void(* OtaTimerCallback_t)(OtaTimerId_t otaTimerId)
Timer callback.
Definition: ota_os_interface.h:183
OTA memory allocation interface.
Definition: ota_os_interface.h:290
void *(* OtaMalloc_t)(size_t size)
Allocate memory.
Definition: ota_os_interface.h:241
OtaOsStatus_t(* OtaSendEvent_t)(OtaEventContext_t *pEventCtx, const void *pEventMsg, unsigned int timeout)
Sends an OTA event.
Definition: ota_os_interface.h:138
@ OtaOsEventQueueReceiveFailed
Failed to receive from the event queue.
Definition: ota_os_interface.h:103
void(* OtaFree_t)(void *ptr)
Free memory.
Definition: ota_os_interface.h:255
OtaEventInterface_t event
OTA Event interface.
Definition: ota_os_interface.h:306
OTA OS Interface.
Definition: ota_os_interface.h:305
OtaMalloc_t malloc
OTA memory allocate interface.
Definition: ota_os_interface.h:295
OtaEventContext_t * pEventContext
Event context to store event information.
Definition: ota_os_interface.h:267
OtaOsStatus_t(* OtaDeinitEvent_t)(OtaEventContext_t *pEventCtx)
Deinitialize the OTA Events mechanism.
Definition: ota_os_interface.h:171
OtaTimerInterface_t timer
OTA Timer interface.
Definition: ota_os_interface.h:307
OTA Retry Timer Interface.
Definition: ota_os_interface.h:275
@ OtaOsTimerStartFailed
Failed to create the timer.
Definition: ota_os_interface.h:106
@ OtaOsTimerStopFailed
Failed to stop the timer.
Definition: ota_os_interface.h:108
OtaTimerId_t
Enumeration for tracking multiple timers.
Definition: ota_os_interface.h:88
@ OtaOsTimerDeleteFailed
Failed to delete the timer.
Definition: ota_os_interface.h:109
OtaSendEvent_t send
Send data.
Definition: ota_os_interface.h:264
OtaOsStatus_t
The OTA OS interface return status.
Definition: ota_os_interface.h:99
OtaDeinitEvent_t deinit
Deinitialize event.
Definition: ota_os_interface.h:266
@ OtaOsEventQueueDeleteFailed
Failed to delete the event queue.
Definition: ota_os_interface.h:104
OtaStartTimer_t start
Timer start state.
Definition: ota_os_interface.h:276
@ OtaOsTimerCreateFailed
Failed to create the timer.
Definition: ota_os_interface.h:105
@ OtaOsEventQueueCreateFailed
Failed to create the event queue.
Definition: ota_os_interface.h:101
OtaOsStatus_t(* OtaDeleteTimer_t)(OtaTimerId_t otaTimerId)
Delete a timer.
Definition: ota_os_interface.h:228
@ OtaOsEventQueueSendFailed
Posting event message to the event queue failed.
Definition: ota_os_interface.h:102
OtaMallocInterface_t mem
OTA memory interface.
Definition: ota_os_interface.h:308
OtaStopTimer_t stop
Timer stop state.
Definition: ota_os_interface.h:277
@ OtaOsTimerRestartFailed
Failed to restart the timer.
Definition: ota_os_interface.h:107
OtaOsStatus_t(* OtaInitEvent_t)(OtaEventContext_t *pEventCtx)
Initialize the OTA events.
Definition: ota_os_interface.h:122
OtaOsStatus_t(* OtaStopTimer_t)(OtaTimerId_t otaTimerId)
Stop timer.
Definition: ota_os_interface.h:216
OtaOsStatus_t(* OtaStartTimer_t)(OtaTimerId_t otaTimerId, const char *const pTimerName, const uint32_t timeout, OtaTimerCallback_t callback)
Start timer.
Definition: ota_os_interface.h:201
OtaFree_t free
OTA memory deallocate interface.
Definition: ota_os_interface.h:297