AWS IoT Jobs v2.0.0
Client library for AWS IoT Jobs
 
Loading...
Searching...
No Matches
job_parser.h
1/*
2 * AWS IoT Jobs v2.0.0
3 * Copyright (C) 2023 Amazon.com, Inc. and its affiliates. All Rights Reserved.
4 * SPDX-License-Identifier: MIT
5 *
6 * Licensed under the MIT License. See the LICENSE accompanying this file
7 * for the specific language governing permissions and limitations under
8 * the License.
9 */
10
11#ifndef JOB_PARSER_H
12#define JOB_PARSER_H
13
14#include <stdbool.h>
15#include <stdlib.h>
16#include <stdint.h>
17
22typedef struct
23{
25 const char * signature;
26
29
31 const char * filepath;
32
35
37 const char * certfile;
38
41
43 const char * authScheme;
44
47
49 const char * imageRef;
50
53
55 uint32_t fileId;
56
58 uint32_t fileSize;
59
61 uint32_t fileType;
63
75/* @[declare_populatejobdocfields] */
76bool populateJobDocFields( const char * jobDoc,
77 const size_t jobDocLength,
78 int32_t fileIndex,
80/* @[declare_populatejobdocfields] */
81
82#endif /* JOB_PARSER_H */
struct containing the fields of an AFR OTA Job Document
Definition: job_parser.h:23
const char * certfile
Path to Code Signing Certificate on Device.
Definition: job_parser.h:37
uint32_t fileSize
Size of the OTA Update.
Definition: job_parser.h:58
uint32_t fileType
File Type.
Definition: job_parser.h:61
const char * authScheme
Authentication Scheme for HTTP URL ( null for MQTT )
Definition: job_parser.h:43
uint32_t fileId
File ID.
Definition: job_parser.h:55
const char * imageRef
MQTT Stream or HTTP URL.
Definition: job_parser.h:49
const char * signature
Code Signing Signature.
Definition: job_parser.h:25
size_t signatureLen
Length of signature.
Definition: job_parser.h:28
size_t certfileLen
Length of certfile.
Definition: job_parser.h:40
size_t imageRefLen
Length of imageRef.
Definition: job_parser.h:52
const char * filepath
File path to store OTA Update on device.
Definition: job_parser.h:31
size_t filepathLen
Length of filepath.
Definition: job_parser.h:34
size_t authSchemeLen
Length of authScheme.
Definition: job_parser.h:46