ota_http_interface.h File Reference

Contains OTA HTTP Statuses, function type definitions and http interface structure. More...

#include <stddef.h>
#include <stdint.h>

Include dependency graph for ota_http_interface.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	OtaHttpInterface_t
	OTA Event Interface structure. More...

Typedefs
typedef OtaHttpStatus_t(*	OtaHttpInit_t) (char *pUrl)
	Init OTA Http interface. More...
typedef OtaHttpStatus_t(*	OtaHttpRequest_t) (uint32_t rangeStart, uint32_t rangeEnd)
	Request file block over Http. More...
typedef OtaHttpStatus_t(*	OtaHttpDeinit) (void)
	Deinit OTA Http interface. More...

Enumerations
enum	OtaHttpStatus_t { OtaHttpSuccess = 0 , OtaHttpInitFailed = 0xc0 , OtaHttpDeinitFailed , OtaHttpRequestFailed }
	The OTA HTTP interface return status. More...

Detailed Description

Contains OTA HTTP Statuses, function type definitions and http interface structure.

Typedef Documentation

OtaHttpInit_t

typedef OtaHttpStatus_t(* OtaHttpInit_t) (char *pUrl)

Init OTA Http interface.

This function parses the pre-signed url and initializes connection.

Parameters

[in]

pUrl

Pointer to the pre-signed url for downloading update file.

Returns

OtaHttpSuccess if success , other error code on failure.

OtaHttpRequest_t

typedef OtaHttpStatus_t(* OtaHttpRequest_t) (uint32_t rangeStart, uint32_t rangeEnd)

Request file block over Http.

This function requests file block over Http from the rangeStart and rangeEnd.

Parameters

[in]	rangeStart	Starting index of the file data to be requested.
[in]	rangeEnd	End index of the file data to be requested.

Returns

OtaHttpSuccess if success , other error code on failure.

OtaHttpDeinit

typedef OtaHttpStatus_t(* OtaHttpDeinit) (void)

Deinit OTA Http interface.

This function cleanups Http connection and other data used for requesting file blocks using the pre-signed url.

Returns

OtaHttpSuccess if success , other error code on failure.