XDK API  3.6.0
Documentation
Files | Data Structures | Typedefs
FotaRegistryAgent

API of the Registry agent. More...

+ Collaboration diagram for FotaRegistryAgent:

Files

file  BCDS_FotaRegistryAgent.h
 

Data Structures

struct  FotaRegistryAgent_Key_S
 This structure will be defined in MACROs per Agent. More...
 
struct  FotaRegistryAgent_S
 

Typedefs

typedef Retcode_T(* FotaRegistryAgent_Deinitialize_T )(void)
 De-initialize the agent. More...
 
typedef Retcode_T(* FotaRegistryAgent_Flush_T )(void)
 Flush the information to persist them. Only possible if it is a controled reboot. More...
 
typedef Retcode_T(* FotaRegistryAgent_Initialize_T )(const EventHub_T *hub, void *configuration)
 Initialize the DownloadAgent. It will prepare the communication interfaces with outside (Backend, etc...) More...
 
typedef struct
FotaRegistryAgent_Key_S 
FotaRegistryAgent_Key_T
 
typedef Retcode_T(* FotaRegistryAgent_Read_T )(FotaRegistryAgent_Key_T key, void *value, uint32_t sizeValue)
 Read the persisted value from the key. More...
 
typedef struct FotaRegistryAgent_S FotaRegistryAgent_T
 
typedef Retcode_T(* FotaRegistryAgent_Write_T )(FotaRegistryAgent_Key_T key, void *value, uint32_t sizeValue)
 Write the persisted value from the key. More...
 

Detailed Description

It's role is to persist other agent values before a reboot..


Data Structure Documentation

struct FotaRegistryAgent_Key_S

Data Fields

uint8_t id
 
uint32_t length_byte
 

Field Documentation

uint8_t id
uint32_t length_byte
struct FotaRegistryAgent_S

Typedef Documentation

typedef Retcode_T(* FotaRegistryAgent_Deinitialize_T)(void)
Returns
RETCODE_NULL_POINTER A null pointer was provided.
RETCODE_FAILURE Description depend of the used agent.
RETCODE_OK
typedef Retcode_T(* FotaRegistryAgent_Flush_T)(void)
Returns
RETCODE_NULL_POINTER A null pointer was provided.
RETCODE_FAILURE Description depend of the used agent.
RETCODE_OK
typedef Retcode_T(* FotaRegistryAgent_Initialize_T)(const EventHub_T *hub, void *configuration)
Parameters
[in]EventHub_T* hub This hub allows to the agent to communicate in an asynchrony way with the application using it.
[in]void* configuration The configuration structures are defined in BCDS_DownloadAgentCfg.h. Their are used to provide the necessary information to the DownloadAgent to fulfill it task.
Returns
RETCODE_NULL_POINTER A null pointer was provided.
RETCODE_FAILURE Description depend of the used agent.
RETCODE_OK
typedef Retcode_T(* FotaRegistryAgent_Read_T)(FotaRegistryAgent_Key_T key, void *value, uint32_t sizeValue)
Parameters
RegistryAgentKey_Tkey Given id to read a value from.
[in]void* value Pointer on the value to write in.
[in]uint32_tsizeValue Size to read. If the size does not match the right length, it will not work.
Returns
RETCODE_NULL_POINTER A null pointer was provided.
RETCODE_FAILURE Description depend of the used agent.
RETCODE_OK
typedef Retcode_T(* FotaRegistryAgent_Write_T)(FotaRegistryAgent_Key_T key, void *value, uint32_t sizeValue)
Parameters
RegistryAgentKey_Tkey Given id to write a value on.
[in]void* value Pointer on the value to copy in.
[in]uint32_tsizeValue Size to write. If the size does not match the right length, it will not work.
Returns
RETCODE_NULL_POINTER A null pointer was provided.
RETCODE_FAILURE Description depend of the used agent.
RETCODE_OK

All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:51 by doxygen 1.8.8