Over The Air (OTA) Update Library
All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
cy_ota_cb_struct_t Struct Reference

Description

Structure passed to the callback.

This holds read/write data for the application to adjust various things in the callback. The callback is not in an interrupt context, but try to keep it quick! After your function returns, this structure is not available.

Data Fields

cy_ota_cb_reason_t reason
 Reason for the callback. More...
 
void * cb_arg
 Argument passed when registering the callback. More...
 
cy_ota_agent_state_t ota_agt_state
 Current OTA Agent state. More...
 
cy_rslt_t error
 Current OTA Agent error status. More...
 
cy_ota_storage_write_info_tstorage
 Pointer to a chunk of data to write. More...
 
uint32_t total_size
 Total # bytes to be downloaded. More...
 
uint32_t bytes_written
 Total # bytes downloaded. More...
 
uint32_t percentage
 Percentage of bytes downloaded. More...
 
cy_ota_connection_t connection_type
 Connection type cy_ota_connection_t. More...
 

Field Documentation

cy_ota_cb_reason_t cy_ota_cb_struct_t::reason

Reason for the callback.

void* cy_ota_cb_struct_t::cb_arg

Argument passed when registering the callback.

cy_ota_agent_state_t cy_ota_cb_struct_t::ota_agt_state

Current OTA Agent state.

cy_rslt_t cy_ota_cb_struct_t::error

Current OTA Agent error status.

cy_ota_storage_write_info_t* cy_ota_cb_struct_t::storage

Pointer to a chunk of data to write.

uint32_t cy_ota_cb_struct_t::total_size

Total # bytes to be downloaded.

uint32_t cy_ota_cb_struct_t::bytes_written

Total # bytes downloaded.

uint32_t cy_ota_cb_struct_t::percentage

Percentage of bytes downloaded.

cy_ota_connection_t cy_ota_cb_struct_t::connection_type

Connection type cy_ota_connection_t.