ota_http_interface.h

Go to the documentation of this file.

/*
 * AWS IoT Over-the-air Update v3.4.1
 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
 
#ifndef OTA_HTTP_INTERFACE_H
#define OTA_HTTP_INTERFACE_H
 
/* *INDENT-OFF* */
#ifdef __cplusplus
    extern "C" {
#endif
/* *INDENT-ON* */
 
/* Standard library includes. */
#include <stddef.h>
#include <stdint.h>
 
typedef enum OtaHttpStatus
{
    OtaHttpSuccess = 0,       
    OtaHttpInitFailed = 0xc0, 
    OtaHttpDeinitFailed,      
    OtaHttpRequestFailed      
} OtaHttpStatus_t;
 
typedef OtaHttpStatus_t ( * OtaHttpInit_t ) ( char * pUrl );
 
typedef OtaHttpStatus_t ( * OtaHttpRequest_t )  ( uint32_t rangeStart,
                                                  uint32_t rangeEnd );
 
typedef OtaHttpStatus_t ( * OtaHttpDeinit )( void );
 
typedef struct OtaHttpInterface
{
    OtaHttpInit_t init;       
    OtaHttpRequest_t request; 
    OtaHttpDeinit deinit;     
} OtaHttpInterface_t;
 
/* *INDENT-OFF* */
#ifdef __cplusplus
    }
#endif
/* *INDENT-ON* */
 
#endif /* ifndef OTA_HTTP_INTERFACE_H */