/* | |
* Amazon FreeRTOS Platform V1.0.0 | |
* Copyright (C) 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. | |
* | |
* 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. | |
* | |
* http://aws.amazon.com/freertos | |
* http://www.FreeRTOS.org | |
*/ | |
/** | |
* @file iot_network_freertos.h | |
* @brief Declares the network stack functions specified in iot_network.h for | |
* FreeRTOS+TCP. | |
*/ | |
#ifndef _IOT_NETWORK_FREERTOS_H_ | |
#define _IOT_NETWORK_FREERTOS_H_ | |
/* Standard includes. */ | |
#include <stdbool.h> | |
/* Platform types include. */ | |
#include "types/iot_platform_types.h" | |
/* Platform network include. */ | |
#include "platform/iot_network.h" | |
/** | |
* @brief Provides a default value for an #IotNetworkConnectionFreeRTOS_t. | |
* | |
* All instances of #IotNetworkConnectionFreeRTOS_t should be initialized with | |
* this constant. | |
* | |
* @warning Failing to initialize an #IotNetworkConnectionFreeRTOS_t with this | |
* initializer may result in undefined behavior! | |
* @note This initializer may change at any time in future versions, but its | |
* name will remain the same. | |
*/ | |
#define IOT_NETWORK_CONNECTION_FREERTOS_INITIALIZER { 0 } | |
/** | |
* @brief Generic initializer for an #IotNetworkServerInfo_t. | |
* | |
* @note This initializer may change at any time in future versions, but its | |
* name will remain the same. | |
*/ | |
#define IOT_NETWORK_SERVER_INFO_FREERTOS_INITIALIZER { 0 } | |
/** | |
* @brief Generic initializer for an #IotNetworkCredentials_t. | |
* | |
* @note This initializer may change at any time in future versions, but its | |
* name will remain the same. | |
*/ | |
#define IOT_NETWORK_CREDENTIALS_FREERTOS_INITIALIZER { 0 } | |
/** | |
* @brief Provides a pointer to an #IotNetworkInterface_t that uses the functions | |
* declared in this file. | |
*/ | |
#define IOT_NETWORK_INTERFACE_FREERTOS ( &( IotNetworkFreeRTOS ) ) | |
/** | |
* @brief One-time initialization function for this network stack. | |
*/ | |
IotNetworkError_t IotNetworkFreeRTOS_Init( void ); | |
/** | |
* @brief One-time cleanup function for this network stack. | |
*/ | |
void IotNetworkFreeRTOS_Cleanup( void ); | |
/** | |
* @brief An implementation of #IotNetworkInterface_t::create for FreeRTOS+TCP | |
* sockets. | |
*/ | |
IotNetworkError_t IotNetworkFreeRTOS_Create( IotNetworkServerInfo_t pServerInfo, | |
IotNetworkCredentials_t pCredentialInfo, | |
IotNetworkConnection_t * pConnection ); | |
/** | |
* @brief An implementation of #IotNetworkInterface_t::setReceiveCallback for | |
* FreeRTOS+TCP sockets. | |
*/ | |
IotNetworkError_t IotNetworkFreeRTOS_SetReceiveCallback( IotNetworkConnection_t pConnection, | |
IotNetworkReceiveCallback_t receiveCallback, | |
void * pContext ); | |
/** | |
* @brief An implementation of #IotNetworkInterface_t::send for FreeRTOS+TCP | |
* sockets. | |
*/ | |
size_t IotNetworkFreeRTOS_Send( IotNetworkConnection_t pConnection, | |
const uint8_t * pMessage, | |
size_t messageLength ); | |
/** | |
* @brief An implementation of #IotNetworkInterface_t::receive for FreeRTOS+TCP | |
* sockets. | |
*/ | |
size_t IotNetworkFreeRTOS_Receive( IotNetworkConnection_t pConnection, | |
uint8_t * pBuffer, | |
size_t bytesRequested ); | |
/** | |
* @brief An implementation of #IotNetworkInterface::receiveUpto for FreeRTOS+TCP | |
* sockets. | |
*/ | |
size_t IotNetworkFreeRTOS_ReceiveUpto( IotNetworkConnection_t pConnection, | |
uint8_t * pBuffer, | |
size_t bufferSize ); | |
/** | |
* @brief An implementation of #IotNetworkInterface_t::close for FreeRTOS+TCP | |
* sockets. | |
*/ | |
IotNetworkError_t IotNetworkFreeRTOS_Close( IotNetworkConnection_t pConnection ); | |
/** | |
* @brief An implementation of #IotNetworkInterface_t::destroy for FreeRTOS+TCP | |
* sockets. | |
*/ | |
IotNetworkError_t IotNetworkFreeRTOS_Destroy( IotNetworkConnection_t pConnection ); | |
/** | |
* @cond DOXYGEN_IGNORE | |
* Doxygen should ignore this section. | |
* | |
* Declaration of a network interface struct using the functions in this file. | |
*/ | |
extern const IotNetworkInterface_t IotNetworkFreeRTOS; | |
/** @endcond */ | |
#endif /* ifndef _IOT_NETWORK_FREERTOS_H_ */ |