]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS-Plus/Source/FreeRTOS-IoT-Libraries/abstractions/platform/freertos/include/platform/iot_network_freertos.h
Remove dependency on secure sockets
[freertos] / FreeRTOS-Plus / Source / FreeRTOS-IoT-Libraries / abstractions / platform / freertos / include / platform / iot_network_freertos.h
index e4449ae2409f0c5992d9cdec21bc05b5beb82b22..fef3367aa9a8e6543949c3ae3f25b8c75dd8d7b0 100644 (file)
 \r
 /**\r
  * @file iot_network_freertos.h\r
- * @brief Declares the network stack functions specified in aws_iot_network.h for\r
- * Amazon FreeRTOS Secure Sockets.\r
+ * @brief Declares the network stack functions specified in iot_network.h for\r
+ * FreeRTOS+TCP.\r
  */\r
 \r
-#ifndef _IOT_NETWORK_AFR_H_\r
-#define _IOT_NETWORK_AFR_H_\r
+#ifndef _IOT_NETWORK_FREERTOS_H_\r
+#define _IOT_NETWORK_FREERTOS_H_\r
 \r
 /* Standard includes. */\r
 #include <stdbool.h>\r
 /* Platform network include. */\r
 #include "platform/iot_network.h"\r
 \r
-/* Amazon FreeRTOS Secure Sockets include. */\r
-#include "iot_secure_sockets.h"\r
-\r
 /**\r
- * @brief Represents a network connection that uses Amazon FreeRTOS Secure Sockets.\r
+ * @brief Represents a network connection that uses FreeRTOS+TCP sockets.\r
  *\r
  * This is an incomplete type. In application code, only pointers to this type\r
  * should be used.\r
  */\r
-typedef struct _networkConnection IotNetworkConnectionAfr_t;\r
+typedef struct _networkConnection IotNetworkConnectionFreeRTOS_t;\r
 \r
 /**\r
- * @brief Provides a default value for an #IotNetworkConnectionAfr_t.\r
+ * @brief Provides a default value for an #IotNetworkConnectionFreeRTOS_t.\r
  *\r
- * All instances of #IotNetworkConnectionAfr_t should be initialized with\r
+ * All instances of #IotNetworkConnectionFreeRTOS_t should be initialized with\r
  * this constant.\r
  *\r
- * @warning Failing to initialize an #IotNetworkConnectionAfr_t with this\r
+ * @warning Failing to initialize an #IotNetworkConnectionFreeRTOS_t with this\r
  * initializer may result in undefined behavior!\r
  * @note This initializer may change at any time in future versions, but its\r
  * name will remain the same.\r
  */\r
-#define IOT_NETWORK_CONNECTION_AFR_INITIALIZER     { 0 }\r
+#define IOT_NETWORK_CONNECTION_FREERTOS_INITIALIZER     { 0 }\r
 \r
 /**\r
  * @brief Generic initializer for an #IotNetworkServerInfo_t.\r
@@ -68,7 +65,7 @@ typedef struct _networkConnection IotNetworkConnectionAfr_t;
  * @note This initializer may change at any time in future versions, but its\r
  * name will remain the same.\r
  */\r
-#define IOT_NETWORK_SERVER_INFO_AFR_INITIALIZER    { 0 }\r
+#define IOT_NETWORK_SERVER_INFO_FREERTOS_INITIALIZER    { 0 }\r
 \r
 /**\r
  * @brief Generic initializer for an #IotNetworkCredentials_t.\r
@@ -76,57 +73,57 @@ typedef struct _networkConnection IotNetworkConnectionAfr_t;
  * @note This initializer may change at any time in future versions, but its\r
  * name will remain the same.\r
  */\r
-#define IOT_NETWORK_CREDENTIALS_AFR_INITIALIZER    { 0 }\r
+#define IOT_NETWORK_CREDENTIALS_FREERTOS_INITIALIZER    { 0 }\r
 \r
 /**\r
  * @brief Provides a pointer to an #IotNetworkInterface_t that uses the functions\r
  * declared in this file.\r
  */\r
-#define IOT_NETWORK_INTERFACE_AFR    ( &( IotNetworkAfr ) )\r
+#define IOT_NETWORK_INTERFACE_FREERTOS                  ( &( IotNetworkFreeRTOS ) )\r
 \r
 /**\r
- * @brief An implementation of #IotNetworkInterface_t::create for Amazon FreeRTOS\r
- * Secure Sockets.\r
+ * @brief An implementation of #IotNetworkInterface_t::create for FreeRTOS+TCP\r
+ * sockets.\r
  */\r
-IotNetworkError_t IotNetworkAfr_Create( void * pConnectionInfo,\r
-                                        void * pCredentialInfo,\r
-                                        void ** const pConnection );\r
+IotNetworkError_t IotNetworkFreeRTOS_Create( void * pConnectionInfo,\r
+                                             void * pCredentialInfo,\r
+                                             void ** const pConnection );\r
 \r
 /**\r
  * @brief An implementation of #IotNetworkInterface_t::setReceiveCallback for\r
- * Amazon FreeRTOS Secure Sockets.\r
+ * FreeRTOS+TCP sockets.\r
  */\r
-IotNetworkError_t IotNetworkAfr_SetReceiveCallback( void * pConnection,\r
-                                                    IotNetworkReceiveCallback_t receiveCallback,\r
-                                                    void * pContext );\r
+IotNetworkError_t IotNetworkFreeRTOS_SetReceiveCallback( void * pConnection,\r
+                                                         IotNetworkReceiveCallback_t receiveCallback,\r
+                                                         void * pContext );\r
 \r
 /**\r
- * @brief An implementation of #IotNetworkInterface_t::send for Amazon FreeRTOS\r
- * Secure Sockets.\r
+ * @brief An implementation of #IotNetworkInterface_t::send for FreeRTOS+TCP\r
+ * sockets.\r
  */\r
-size_t IotNetworkAfr_Send( void * pConnection,\r
-                           const uint8_t * pMessage,\r
-                           size_t messageLength );\r
+size_t IotNetworkFreeRTOS_Send( void * pConnection,\r
+                                const uint8_t * pMessage,\r
+                                size_t messageLength );\r
 \r
 /**\r
- * @brief An implementation of #IotNetworkInterface_t::receive for Amazon FreeRTOS\r
- * Secure Sockets.\r
+ * @brief An implementation of #IotNetworkInterface_t::receive for FreeRTOS+TCP\r
+ * sockets.\r
  */\r
-size_t IotNetworkAfr_Receive( void * pConnection,\r
-                              uint8_t * pBuffer,\r
-                              size_t bytesRequested );\r
+size_t IotNetworkFreeRTOS_Receive( void * pConnection,\r
+                                   uint8_t * pBuffer,\r
+                                   size_t bytesRequested );\r
 \r
 /**\r
- * @brief An implementation of #IotNetworkInterface_t::close for Amazon FreeRTOS\r
- * Secure Sockets.\r
+ * @brief An implementation of #IotNetworkInterface_t::close for FreeRTOS+TCP\r
+ * sockets.\r
  */\r
-IotNetworkError_t IotNetworkAfr_Close( void * pConnection );\r
+IotNetworkError_t IotNetworkFreeRTOS_Close( void * pConnection );\r
 \r
 /**\r
- * @brief An implementation of #IotNetworkInterface_t::destroy for Amazon FreeRTOS\r
- * Secure Sockets.\r
+ * @brief An implementation of #IotNetworkInterface_t::destroy for FreeRTOS+TCP\r
+ * sockets.\r
  */\r
-IotNetworkError_t IotNetworkAfr_Destroy( void * pConnection );\r
+IotNetworkError_t IotNetworkFreeRTOS_Destroy( void * pConnection );\r
 \r
 /**\r
  * @cond DOXYGEN_IGNORE\r
@@ -134,7 +131,7 @@ IotNetworkError_t IotNetworkAfr_Destroy( void * pConnection );
  *\r
  * Declaration of a network interface struct using the functions in this file.\r
  */\r
-extern const IotNetworkInterface_t IotNetworkAfr;\r
+extern const IotNetworkInterface_t IotNetworkFreeRTOS;\r
 /** @endcond */\r
 \r
-#endif /* ifndef _IOT_NETWORK_AFR_H_ */\r
+#endif /* ifndef _IOT_NETWORK_FREERTOS_H_ */\r