AWS IoT Over-the-air Update  v2.0.0 (Release Candidate)
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 v2.0.0 (Release Candidate)
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 /* Standard library includes. */
32 #include <stddef.h>
33 #include <stdint.h>
34 
79 typedef enum OtaHttpStatus
80 {
86 
97 typedef OtaHttpStatus_t ( * OtaHttpInit_t ) ( char * pUrl );
98 
111 typedef OtaHttpStatus_t ( * OtaHttpRequest_t ) ( uint32_t rangeStart,
112  uint32_t rangeEnd );
113 
122 typedef OtaHttpStatus_t ( * OtaHttpDeinit )( void );
123 
129 typedef struct OtaHttpInterface
130 {
135 
136 #endif /* ifndef OTA_HTTP_INTERFACE_H */
OtaHttpInterface_t::init
OtaHttpInit_t init
Reference to HTTP initialization.
Definition: ota_http_interface.h:131
OtaHttpInitFailed
@ OtaHttpInitFailed
Error initializing the HTTP connection.
Definition: ota_http_interface.h:82
OtaHttpRequest_t
OtaHttpStatus_t(* OtaHttpRequest_t)(uint32_t rangeStart, uint32_t rangeEnd)
Request file block over Http.
Definition: ota_http_interface.h:111
OtaHttpSuccess
@ OtaHttpSuccess
OTA HTTP interface success.
Definition: ota_http_interface.h:81
OtaHttpInit_t
OtaHttpStatus_t(* OtaHttpInit_t)(char *pUrl)
Init OTA Http interface.
Definition: ota_http_interface.h:97
OtaHttpInterface_t::request
OtaHttpRequest_t request
Reference to HTTP data request.
Definition: ota_http_interface.h:132
OtaHttpInterface_t::deinit
OtaHttpDeinit deinit
Reference to HTTP deinitialize.
Definition: ota_http_interface.h:133
OtaHttpDeinitFailed
@ OtaHttpDeinitFailed
Error deinitializing the HTTP connection.
Definition: ota_http_interface.h:83
OtaHttpRequestFailed
@ OtaHttpRequestFailed
Error sending the HTTP request.
Definition: ota_http_interface.h:84
OtaHttpInterface_t
OTA Event Interface structure.
Definition: ota_http_interface.h:130
OtaHttpDeinit
OtaHttpStatus_t(* OtaHttpDeinit)(void)
Deinit OTA Http interface.
Definition: ota_http_interface.h:122
OtaHttpStatus_t
OtaHttpStatus_t
The OTA HTTP interface return status.
Definition: ota_http_interface.h:80