ota_http_private.h File Reference

Contains definitions of routines for OTA download using HTTP data plane. More...

#include "ota.h"
#include "ota_private.h"

Include dependency graph for ota_http_private.h:

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

Go to the source code of this file.

Functions
OtaErr_t	initFileTransfer_Http (const OtaAgentContext_t *pAgentCtx)
	Initialize file transfer over HTTP. More...
OtaErr_t	requestDataBlock_Http (OtaAgentContext_t *pAgentCtx)
	Request File block over HTTP. More...
OtaErr_t	decodeFileBlock_Http (const uint8_t *pMessageBuffer, size_t messageSize, int32_t *pFileId, int32_t *pBlockId, int32_t *pBlockSize, uint8_t *const *pPayload, size_t *pPayloadSize)
	Stub for decoding the file block. More...
OtaErr_t	cleanupData_Http (const OtaAgentContext_t *pAgentCtx)
	Cleanup related to OTA data plane over HTTP. More...
const char *	OTA_HTTP_strerror (OtaHttpStatus_t status)
	Status to string conversion for OTA HTTP interface status. More...

Detailed Description

Contains definitions of routines for OTA download using HTTP data plane.

Function Documentation

initFileTransfer_Http()

OtaErr_t initFileTransfer_Http

(

const OtaAgentContext_t *

pAgentCtx

)

Initialize file transfer over HTTP.

This function initializes the file transfer after the OTA job is parsed and accepted by initializing the http component with pre-signed url.

Parameters

[in]

pAgentCtx

The OTA agent context.

Returns

The OTA error code. See OTA Agent error codes information in ota.h.

requestDataBlock_Http()

OtaErr_t requestDataBlock_Http

(

OtaAgentContext_t *

pAgentCtx

)

Request File block over HTTP.

This function is used for requesting a file block over HTTP using the file context.

Parameters

[in]

pAgentCtx

The OTA agent context.

Returns

The OTA PAL layer error code combined with the MCU specific error code. See OTA Agent error codes information in ota.h.

decodeFileBlock_Http()

OtaErr_t decodeFileBlock_Http	(	const uint8_t *	pMessageBuffer,
		size_t	messageSize,
		int32_t *	pFileId,
		int32_t *	pBlockId,
		int32_t *	pBlockSize,
		uint8_t *const *	pPayload,
		size_t *	pPayloadSize
	)

Stub for decoding the file block.

File block received over HTTP does not require decoding, only increment the number of blocks received.

Parameters

[in]	pMessageBuffer	The message to be decoded.
[in]	messageSize	The size of the message in bytes.
[out]	pFileId	The server file ID.
[out]	pBlockId	The file block ID.
[out]	pBlockSize	The file block size.
[out]	pPayload	The payload.
[out]	pPayloadSize	The payload size.

Returns

The OTA PAL layer error code combined with the MCU specific error code. See OTA Agent error codes information in ota.h.

cleanupData_Http()

OtaErr_t cleanupData_Http

(

const OtaAgentContext_t *

pAgentCtx

)

Cleanup related to OTA data plane over HTTP.

This function performs cleanup by resetting the number of blocks received and deinit the http component.

Parameters

[in]

pAgentCtx

The OTA agent context.

Returns

The OTA error code. See OTA Agent error codes information in ota.h.

OTA_HTTP_strerror()

const char * OTA_HTTP_strerror

(

OtaHttpStatus_t

status

)

Status to string conversion for OTA HTTP interface status.

Parameters

[in]

status

The status to convert to a string.

Returns

The string representation of the status.