AWS IoT Over-the-air Update v3.2.0
Client library for AWS IoT OTA
ota_http_interface.h
Go to the documentation of this file.
1/*
2 * AWS IoT Over-the-air Update v3.2.0
3 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a copy of
6 * this software and associated documentation files (the "Software"), to deal in
7 * the Software without restriction, including without limitation the rights to
8 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9 * the Software, and to permit persons to whom the Software is furnished to do so,
10 * subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in all
13 * copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21 */
22
28#ifndef OTA_HTTP_INTERFACE_H
29#define OTA_HTTP_INTERFACE_H
30
31/* *INDENT-OFF* */
32#ifdef __cplusplus
33 extern "C" {
34#endif
35/* *INDENT-ON* */
36
37/* Standard library includes. */
38#include <stddef.h>
39#include <stdint.h>
40
85typedef enum OtaHttpStatus
86{
92
103typedef OtaHttpStatus_t ( * OtaHttpInit_t ) ( char * pUrl );
104
117typedef OtaHttpStatus_t ( * OtaHttpRequest_t ) ( uint32_t rangeStart,
118 uint32_t rangeEnd );
119
128typedef OtaHttpStatus_t ( * OtaHttpDeinit )( void );
129
135typedef struct OtaHttpInterface
136{
141
142/* *INDENT-OFF* */
143#ifdef __cplusplus
144 }
145#endif
146/* *INDENT-ON* */
147
148#endif /* ifndef OTA_HTTP_INTERFACE_H */
OtaHttpStatus_t
The OTA HTTP interface return status.
Definition: ota_http_interface.h:86
@ OtaHttpInitFailed
Error initializing the HTTP connection.
Definition: ota_http_interface.h:88
@ OtaHttpRequestFailed
Error sending the HTTP request.
Definition: ota_http_interface.h:90
@ OtaHttpDeinitFailed
Error deinitializing the HTTP connection.
Definition: ota_http_interface.h:89
@ OtaHttpSuccess
OTA HTTP interface success.
Definition: ota_http_interface.h:87
OtaHttpStatus_t(* OtaHttpRequest_t)(uint32_t rangeStart, uint32_t rangeEnd)
Request file block over Http.
Definition: ota_http_interface.h:117
OtaHttpStatus_t(* OtaHttpInit_t)(char *pUrl)
Init OTA Http interface.
Definition: ota_http_interface.h:103
OtaHttpStatus_t(* OtaHttpDeinit)(void)
Deinit OTA Http interface.
Definition: ota_http_interface.h:128
OTA Event Interface structure.
Definition: ota_http_interface.h:136
OtaHttpDeinit deinit
Reference to HTTP deinitialize.
Definition: ota_http_interface.h:139
OtaHttpRequest_t request
Reference to HTTP data request.
Definition: ota_http_interface.h:138
OtaHttpInit_t init
Reference to HTTP initialization.
Definition: ota_http_interface.h:137