OTA File Context Information. More...

#include <aws_ota_agent.h>

Data Fields
uint8_t *	pacFilepath

union {
int32_t iFileHandle

uint8_t * pucFile

};

TimerHandle_t	pvRequestTimer

uint32_t	ulFileSize

uint32_t	ulBlocksRemaining

uint32_t	ulFileAttributes

uint32_t	ulServerFileID

uint32_t	ulRequestMomentum

uint8_t *	pacJobName

uint8_t *	pacStreamName

Sig256_t *	pxSignature

uint8_t *	pacRxBlockBitmap

uint8_t *	pacCertFilepath

uint32_t	ulUpdaterVersion

bool_t	bIsInSelfTest

Detailed Description

OTA File Context Information.

Information about an OTA Update file that is to be streamed. This structure is filled in from a job notification MQTT message. Currently only one file context can be streamed at time.

Definition at line 211 of file aws_ota_agent.h.

Field Documentation

◆ bIsInSelfTest

bool_t bIsInSelfTest

True if the job is in self test mode.

Definition at line 235 of file aws_ota_agent.h.

◆ iFileHandle

int32_t iFileHandle

Device internal file pointer or handle. File type is handle after file is open for write.

Definition at line 216 of file aws_ota_agent.h.

◆ pacCertFilepath

uint8_t* pacCertFilepath

Pathname of the certificate file used to validate the receive file.

Definition at line 233 of file aws_ota_agent.h.

◆ pacFilepath

uint8_t* pacFilepath

Local file pathname.

Definition at line 213 of file aws_ota_agent.h.

◆ pacJobName

uint8_t* pacJobName

The job name associated with this file from the job service.

Definition at line 229 of file aws_ota_agent.h.

◆ pacRxBlockBitmap

uint8_t* pacRxBlockBitmap

Bitmap of blocks received (for de-duping and missing block request).

Definition at line 232 of file aws_ota_agent.h.

◆ pacStreamName

uint8_t* pacStreamName

The stream associated with this file from the OTA service.

Definition at line 230 of file aws_ota_agent.h.

◆ pucFile

uint8_t* pucFile

File type is RAM/Flash image pointer after file is open for write.

Definition at line 221 of file aws_ota_agent.h.

◆ pvRequestTimer

TimerHandle_t pvRequestTimer

The request timer associated with this OTA context.

Definition at line 223 of file aws_ota_agent.h.

◆ pxSignature

Sig256_t* pxSignature

Pointer to the file's signature structure.

Definition at line 231 of file aws_ota_agent.h.

◆ ulBlocksRemaining

uint32_t ulBlocksRemaining

How many blocks remain to be received (a code optimization).

Definition at line 225 of file aws_ota_agent.h.

◆ ulFileAttributes

uint32_t ulFileAttributes

Flags specific to the file being received (e.g. secure, bundle, archive).

Definition at line 226 of file aws_ota_agent.h.

◆ ulFileSize

uint32_t ulFileSize

The size of the file in bytes.

Definition at line 224 of file aws_ota_agent.h.

◆ ulRequestMomentum

uint32_t ulRequestMomentum

The number of stream requests published before a response was received.

Definition at line 228 of file aws_ota_agent.h.

◆ ulServerFileID

uint32_t ulServerFileID

The file is referenced by this numeric ID in the OTA job.

Definition at line 227 of file aws_ota_agent.h.

◆ ulUpdaterVersion

uint32_t ulUpdaterVersion

Used by OTA self-test detection, the version of FW that did the update.

Definition at line 234 of file aws_ota_agent.h.

The documentation for this struct was generated from the following file:

C:/AFR/freertos-master/lib/include/aws_ota_agent.h

Data Fields