XDK API  3.6.0
Documentation
Modules | Files | Data Structures | Typedefs
FotaDownloadAgent

API of the DonwloadAgent. More...

+ Collaboration diagram for FotaDownloadAgent:

Modules

 CoapDownloadAgent
 Supports CoAP download client based blockwise download related functionalities. Requests and receives the blocks to and fro from the server (through LWM2M stack's CoAP layer) and partition agent.
 
 OadDownloadAgent
 Supports OAD download client based blockwise download related functionalities. Requests and receives the blocks to and from the central device and partition agent.
 

Files

file  BCDS_FotaDownloadAgent.h
 

Data Structures

struct  FotaDownloadAgent_S
 

Typedefs

typedef Retcode_T(* FotaDownloadAgent_Deinitialize_T )(void)
 Deinitialize the agent. More...
 
typedef Retcode_T(* FotaDownloadAgent_InitalizeDownload_T )(void *configuration)
 When this method is called, the downloadAgent will start the download (connection to back-end, requests, etc...) More...
 
typedef Retcode_T(* FotaDownloadAgent_Initialize_T )(FotaPartitionAgent_T *partitionAgent, FotaRegistryAgent_T *registryAgent, EventHub_T *hub)
 Initialization function of the downloadAgent. It will initialize all what it needs to run. More...
 
typedef Retcode_T(* FotaDownloadAgent_ResumeDownload_T )(void *configuration)
 When this method is called, the downloadAgent will resume the download (connection to back-end, requests, etc...) More...
 
typedef Retcode_T(* FotaDownloadAgent_StopDownload_T )(void)
 When this method is called, the downloadAgent will stop the download. More...
 
typedef struct FotaDownloadAgent_S FotaDownloadAgent_T
 
typedef Retcode_T(* FotaDownloadAgent_UpdateStatus_T )(void *status)
 When this method is called, the downloadAgent will update the status to the server/gateway. More...
 

Detailed Description

It's role is to download a firmware.


Data Structure Documentation

struct FotaDownloadAgent_S

Typedef Documentation

typedef Retcode_T(* FotaDownloadAgent_Deinitialize_T)(void)
Returns
RETCODE_OK Deinit successful
typedef Retcode_T(* FotaDownloadAgent_InitalizeDownload_T)(void *configuration)
Parameters
[in]void* configuration possible configuration to start the download.
Returns
RETCODE_NULL_POINTER A null pointer was provided.
FOTA_DL_DOWNLOAD_INPROGRESS When FOTA download is in progress
RETCODE_UNINITIALIZED If the download agent context is uninitialized
RETCODE_INVALID_PARAM If CmdProcessorHandle is null / PackageUrl string length is greater than or equal to size of PackageUrl
FOTA_FAILED_TO_SETUP_NEW_DOWNLOAD when setting new download fails
RETCODE_FAILURE when the queue is full (Refer CmdProcessor_Enqueue for more information)
RETCODE_OK Initialize download was successful
typedef Retcode_T(* FotaDownloadAgent_Initialize_T)(FotaPartitionAgent_T *partitionAgent, FotaRegistryAgent_T *registryAgent, EventHub_T *hub)
Parameters
[in]FotaPartitionAgent_T* downloadPartitionAgent This agent handle the download partition (where we will store our new firmware after a fota).
[in]FotaRegistryAgent_T* registryAgent This agent is used to save the internal state of the agent before a reboot.
[in]EventHub_T* hub This hub allows to the agent to communicate in an asynchrony way with the application using it.
Returns
RETCODE_NULL_POINTER A null pointer was provided.
RETCODE_FAILURE Description depend of the used agent.
RETCODE_OK Initialization was successful
typedef Retcode_T(* FotaDownloadAgent_ResumeDownload_T)(void *configuration)
Parameters
[in]void* configuration possible configuration to start the download.
Returns
RETCODE_NULL_POINTER A null pointer was provided.
FOTA_DL_DOWNLOAD_INPROGRESS when the fota download status is true
RETCODE_UNINITIALIZED If the download agent context is uninitialized
RETCODE_FAILURE when the queue is full (Refer CmdProcessor_Enqueue for more information) Description depend of the used agent.
Based on the status of Erase operation on selected partition
RETCODE_OK Resume download was successful
typedef Retcode_T(* FotaDownloadAgent_StopDownload_T)(void)
Returns
RETCODE_UNINITIALIZED If the download agent context is uninitialized
FOTA_DL_DOWNLOAD_NOT_INPROGRESS When the fota download is not in progress
RETCODE_FAILURE when the queue is full (Refer CmdProcessor_Enqueue for more information)
RETCODE_OK stop download was successful
typedef Retcode_T(* FotaDownloadAgent_UpdateStatus_T)(void *status)
Returns
RETCODE_NULL_POINTER A null pointer was provided.
RETCODE_OK update of status was successful

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