AWS IoT Over-the-air Update
v3.0.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
71 struct OtaEventContext;
92 typedef enum OtaOsStatus
133 const void * pEventMsg,
134 unsigned int timeout );
196 const char *
const pTimerName,
197 const uint32_t timeout,
235 typedef void * ( * OtaMalloc_t ) (
size_t size );
255 typedef struct OtaEventInterface
268 typedef struct OtaTimerInterface
279 typedef struct OtaMallocInterface
294 typedef struct OtaOSInterface
Definition: ota_os_interface.h:256
OtaInitEvent_t init
Initialization event.
Definition: ota_os_interface.h:257
OtaReceiveEvent_t recv
Receive data.
Definition: ota_os_interface.h:259
@ OtaOsSuccess
OTA OS interface success.
Definition: ota_os_interface.h:94
struct OtaEventContext OtaEventContext_t
Type definition for Event Context.
Definition: ota_os_interface.h:76
OtaOsStatus_t(* OtaReceiveEvent_t)(OtaEventContext_t *pEventCtx, void *pEventMsg, uint32_t timeout)
Receive an OTA event.
Definition: ota_os_interface.h:150
void(* OtaTimerCallback_t)(OtaTimerId_t otaTimerId)
Timer callback.
Definition: ota_os_interface.h:177
OTA memory allocation interface.
Definition: ota_os_interface.h:280
void *(* OtaMalloc_t)(size_t size)
Allocate memory.
Definition: ota_os_interface.h:235
OtaOsStatus_t(* OtaSendEvent_t)(OtaEventContext_t *pEventCtx, const void *pEventMsg, unsigned int timeout)
Sends an OTA event.
Definition: ota_os_interface.h:132
@ OtaOsEventQueueReceiveFailed
Failed to receive from the event queue.
Definition: ota_os_interface.h:97
void(* OtaFree_t)(void *ptr)
Free memory.
Definition: ota_os_interface.h:249
OtaEventInterface_t event
OTA Event interface.
Definition: ota_os_interface.h:296
OTA OS Interface.
Definition: ota_os_interface.h:295
OtaMalloc_t malloc
OTA memory allocate interface.
Definition: ota_os_interface.h:285
OtaEventContext_t * pEventContext
Event context to store event information.
Definition: ota_os_interface.h:261
OtaOsStatus_t(* OtaDeinitEvent_t)(OtaEventContext_t *pEventCtx)
Deinitialize the OTA Events mechanism.
Definition: ota_os_interface.h:165
OtaTimerInterface_t timer
OTA Timer interface.
Definition: ota_os_interface.h:297
OtaStartTimer_t startTimer
Timer start state.
Definition: ota_os_interface.h:270
OTA Retry Timer Interface.
Definition: ota_os_interface.h:269
@ OtaOsTimerStartFailed
Failed to create the timer.
Definition: ota_os_interface.h:100
@ OtaOsTimerStopFailed
Failed to stop the timer.
Definition: ota_os_interface.h:102
OtaTimerId_t
Enumeration for tracking multiple timers.
Definition: ota_os_interface.h:82
@ OtaOsTimerDeleteFailed
Failed to delete the timer.
Definition: ota_os_interface.h:103
OtaSendEvent_t send
Send data.
Definition: ota_os_interface.h:258
OtaOsStatus_t
The OTA OS interface return status.
Definition: ota_os_interface.h:93
OtaDeinitEvent_t deinit
Deinitialize event.
Definition: ota_os_interface.h:260
OtaDeleteTimer_t deleteTimer
Delete timer.
Definition: ota_os_interface.h:272
@ OtaOsEventQueueDeleteFailed
Failed to delete the event queue.
Definition: ota_os_interface.h:98
@ OtaOsTimerCreateFailed
Failed to create the timer.
Definition: ota_os_interface.h:99
@ OtaOsEventQueueCreateFailed
Failed to create the event queue.
Definition: ota_os_interface.h:95
OtaOsStatus_t(* OtaDeleteTimer_t)(OtaTimerId_t otaTimerId)
Delete a timer.
Definition: ota_os_interface.h:222
@ OtaOsEventQueueSendFailed
Posting event message to the event queue failed.
Definition: ota_os_interface.h:96
OtaMallocInterface_t mem
OTA memory interface.
Definition: ota_os_interface.h:298
@ OtaOsTimerRestartFailed
Failed to restart the timer.
Definition: ota_os_interface.h:101
OtaOsStatus_t(* OtaInitEvent_t)(OtaEventContext_t *pEventCtx)
Initialize the OTA events.
Definition: ota_os_interface.h:116
OtaOsStatus_t(* OtaStopTimer_t)(OtaTimerId_t otaTimerId)
Stop timer.
Definition: ota_os_interface.h:210
OtaStopTimer_t stopTimer
Timer stop state.
Definition: ota_os_interface.h:271
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:195
OtaFree_t free
OTA memory deallocate interface.
Definition: ota_os_interface.h:287