-/*\r
- * Amazon FreeRTOS Secure Sockets V1.1.5\r
- * Copyright (C) 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://aws.amazon.com/freertos\r
- * http://www.FreeRTOS.org\r
- */\r
-\r
-/**\r
- * @file iot_secure_sockets.h\r
- * @brief Secure Sockets Interface.\r
- *\r
- * Secure sockets is a portable layer for establishing a TCP/IP\r
- * connection, with the option of using TLS.\r
- *\r
- * Secure sockets is based on the Berkeley sockets API.\r
- * A few difference general differences between Berkeley and SOCKETS are:\r
- * - SOCKETS has additional socket options to enable TLS, server name\r
- * indication, and per-socket root of trust server certificates. See\r
- * SOCKETS_SetSockOpt() for more information.\r
- * - SOCKETS API return an error code, rather than returning -1 and setting\r
- * a global errno value.\r
- *\r
- */\r
-\r
-#ifndef _AWS_SECURE_SOCKETS_H_\r
-#define _AWS_SECURE_SOCKETS_H_\r
-\r
-/*\r
- #ifdef __cplusplus\r
- * extern "C" {\r
- #endif\r
- */\r
-#include <stdint.h>\r
-#include <stddef.h>\r
-#include "iot_secure_sockets_config.h"\r
-#include "iot_secure_sockets_config_defaults.h"\r
-#include "iot_secure_sockets_wrapper_metrics.h"\r
-#include "iot_lib_init.h"\r
-\r
-/**\r
- * @ingroup SecureSockets_datatypes_handles\r
- * @brief The socket handle data type.\r
- *\r
- * For detail of socket, refer to [Network Sockets]\r
- * (https://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/socket.html)\r
- *\r
- * Data contained by the Socket_t type is port specific.\r
- */\r
-typedef void * Socket_t;\r
-\r
-/**\r
- * @brief The "size_t" of secure sockets.\r
- *\r
- * This type is used for compatibility with the expected Berkeley sockets\r
- * naming.\r
- */\r
-#define Socklen_t uint32_t\r
-\r
-/**\r
- * @anchor SocketsErrors\r
- * @name SocketsErrors\r
- * @brief Error codes returned by the SOCKETS API.\r
- *\r
- * Note that SOCKETS API may also propagate port-specific\r
- * error codes when they are more descriptive. See your\r
- * port's error codes for more details.\r
- * PORT_SPECIFIC_LINK\r
- */\r
-/**@{ */\r
-\r
-#define SOCKETS_ERROR_NONE ( 0 ) /*!< No error. */\r
-#define SOCKETS_SOCKET_ERROR ( -1 ) /*!< Catch-all sockets error code. */\r
-#define SOCKETS_EWOULDBLOCK ( -11 ) /*!< A resource is temporarily unavailable. */\r
-#define SOCKETS_ENOMEM ( -12 ) /*!< Memory allocation failed. */\r
-#define SOCKETS_EINVAL ( -22 ) /*!< Invalid argument. */\r
-#define SOCKETS_ENOPROTOOPT ( -109 ) /*!< A bad option was specified . */\r
-#define SOCKETS_ENOTCONN ( -126 ) /*!< The supplied socket is not connected. */\r
-#define SOCKETS_EISCONN ( -127 ) /*!< The supplied socket is already connected. */\r
-#define SOCKETS_ECLOSED ( -128 ) /*!< The supplied socket has already been closed. */\r
-#define SOCKETS_TLS_INIT_ERROR ( -1001 ) /*!< TLS initialization failed. */\r
-#define SOCKETS_TLS_HANDSHAKE_ERROR ( -1002 ) /*!< TLS handshake failed. */\r
-#define SOCKETS_TLS_SERVER_UNVERIFIED ( -1003 ) /*!< A connection was made but the server could not be verified. It is recommended that the socket be closed. */\r
-#define SOCKETS_TLS_RECV_ERROR ( -1004 ) /*!< TLS receive operation failed. */\r
-#define SOCKETS_TLS_SEND_ERROR ( -1005 ) /*!< TLS send operation failed. */\r
-#define SOCKETS_PERIPHERAL_RESET ( -1006 ) /*!< Communications peripheral has been reset. */\r
-/**@} */\r
-\r
-/**\r
- * @brief Assigned to an Socket_t variable when the socket is not valid.\r
- */\r
-#define SOCKETS_INVALID_SOCKET ( ( Socket_t ) ~0U )\r
-\r
-/**\r
- * @anchor SocketDomains\r
- * @name SocketDomains\r
- *\r
- * @brief Options for the lDomain parameter of SOCKETS_Socket()\r
- * function.\r
- *\r
- * These select the protocol family to be used for communication.\r
- */\r
-/**@{ */\r
-#define SOCKETS_AF_INET ( 2 ) /*!< IPv4 Internet Protocols. */\r
-#define SOCKETS_PF_INET SOCKETS_AF_INET /*!< IPv4 Internet Protocol. */\r
-#define SOCKETS_AF_INET6 ( 10 ) /*!< IPv6 Internet Protocols. This option is currently not supported. */\r
-/**@} */\r
-\r
-/**\r
- * @anchor SocketTypes\r
- * @name SocketTypes\r
- *\r
- * @brief Options for the lType parameter of SOCKETS_Socket()\r
- * function.\r
- *\r
- * These specify the communication semantics.\r
- */\r
-/**@{ */\r
-#define SOCKETS_SOCK_DGRAM ( 2 ) /*!< Datagram. */\r
-#define SOCKETS_SOCK_STREAM ( 1 ) /*!< Byte-stream. */\r
-/**@} */\r
-\r
-/**\r
- * @anchor Protocols\r
- * @name Protocols\r
- *\r
- * @brief Options for the lProtocol parameter of SOCKETS_Socket() function.\r
- *\r
- */\r
-/**@{ */\r
-#define SOCKETS_IPPROTO_UDP ( 17 ) /*!< UDP. This option is currently not supported. */\r
-#define SOCKETS_IPPROTO_TCP ( 6 ) /*!< TCP. */\r
-/**@} */\r
-\r
-/**\r
- * @anchor SetSockOptOptions\r
- * @name SetSockOptOptions\r
- *\r
- * @brief Options for lOptionName in SOCKETS_SetSockOpt().\r
- *\r
- */\r
-/**@{ */\r
-#define SOCKETS_SO_RCVTIMEO ( 0 ) /**< Set the receive timeout. */\r
-#define SOCKETS_SO_SNDTIMEO ( 1 ) /**< Set the send timeout. */\r
-#define SOCKETS_SO_SNDBUF ( 4 ) /**< Set the size of the send buffer (TCP only). */\r
-#define SOCKETS_SO_RCVBUF ( 5 ) /**< Set the size of the receive buffer (TCP only). */\r
-#define SOCKETS_SO_SERVER_NAME_INDICATION ( 6 ) /**< Toggle client use of TLS SNI. */\r
-#define SOCKETS_SO_TRUSTED_SERVER_CERTIFICATE ( 7 ) /**< Override default TLS server certificate trust. Must be PEM encoded and length must include null terminator. */\r
-#define SOCKETS_SO_REQUIRE_TLS ( 8 ) /**< Toggle client enforcement of TLS. */\r
-#define SOCKETS_SO_NONBLOCK ( 9 ) /**< Socket is nonblocking. */\r
-#define SOCKETS_SO_ALPN_PROTOCOLS ( 10 ) /**< Application protocol list to be included in TLS ClientHello. */\r
-#define SOCKETS_SO_WAKEUP_CALLBACK ( 17 ) /**< Set the callback to be called whenever there is data available on the socket for reading. */\r
-\r
-/**@} */\r
-\r
-/**\r
- * @anchor ShutdownFlags <br>\r
- * @name ShutdownFlags\r
- *\r
- * @brief Options for the ulHow parameter in SOCKETS_Shutdown().\r
- */\r
-/**@{ */\r
-#define SOCKETS_SHUT_RD ( 0 ) /**< No further receives. */\r
-#define SOCKETS_SHUT_WR ( 1 ) /**< No further sends. */\r
-#define SOCKETS_SHUT_RDWR ( 2 ) /**< No further send or receive. */\r
-/**@} */\r
-\r
-/**\r
- * @brief Maximum length of an ASCII DNS name.\r
- */\r
-#define securesocketsMAX_DNS_NAME_LENGTH ( 253 )\r
-\r
-/**\r
- * @ingroup SecureSockets_datatypes_paramstructs\r
- * @brief Socket address.\r
- *\r
- * \sa PORT_SPECIFIC_LINK\r
- */\r
-typedef struct SocketsSockaddr\r
-{\r
- uint8_t ucLength; /**< Length of SocketsSockaddr structure. */\r
- uint8_t ucSocketDomain; /**< Only SOCKETS_AF_INET is supported. */\r
- uint16_t usPort; /**< Port number. Convention is to call this sin_port. */\r
- uint32_t ulAddress; /**< IP Address. Convention is to call this sin_addr. */\r
-} SocketsSockaddr_t;\r
-\r
-/**\r
- * @brief Well-known port numbers.\r
- */\r
-#define securesocketsDEFAULT_TLS_DESTINATION_PORT 443\r
-\r
-/**\r
- * @brief Secure Sockets library initialization function.\r
- *\r
- * This function does general initialization and setup. It must be called once\r
- * and only once before calling any other function.\r
- *\r
- * @return\r
- * * `pdPASS` if everything succeeds\r
- * * `pdFAIL` otherwise.\r
- */\r
-lib_initDECLARE_LIB_INIT( SOCKETS_Init );\r
-\r
-/**\r
- * @brief Creates a TCP socket.\r
- *\r
- * See the [FreeRTOS+TCP networking tutorial]\r
- * (https://freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/TCP_Networking_Tutorial.html)\r
- * for more information on TCP sockets.\r
- *\r
- * See the [Berkeley Sockets API]\r
- * (https://en.wikipedia.org/wiki/Berkeley_sockets#Socket_API_functions)\r
- * in wikipedia\r
- *\r
- * @sa SOCKETS_Close()\r
- *\r
- * @param[in] lDomain Must be set to SOCKETS_AF_INET. See @ref SocketDomains.\r
- * @param[in] lType Set to SOCKETS_SOCK_STREAM to create a TCP socket.\r
- * No other value is valid. See @ref SocketTypes.\r
- * @param[in] lProtocol Set to SOCKETS_IPPROTO_TCP to create a TCP socket.\r
- * No other value is valid. See @ref Protocols.\r
- *\r
- * @return\r
- * * If a socket is created successfully, then the socket handle is\r
- * returned\r
- * * @ref SOCKETS_INVALID_SOCKET is returned if an error occurred.\r
- */\r
-\r
-/*\r
- * This call allocates memory and claims a socket resource.\r
- */\r
-/* @[declare_secure_sockets_socket] */\r
-Socket_t SOCKETS_Socket( int32_t lDomain,\r
- int32_t lType,\r
- int32_t lProtocol );\r
-/* @[declare_secure_sockets_socket] */\r
-\r
-\r
-/**\r
- * @brief Connects the socket to the specified IP address and port.\r
- *\r
- * The socket must first have been successfully created by a call to SOCKETS_Socket().\r
- *\r
- * \note To create a secure socket, SOCKETS_SetSockOpt() should be called with the\r
- * SOCKETS_SO_REQUIRE_TLS option \a before SOCKETS_Connect() is called.\r
- *\r
- * If this function returns an error the socket is considered invalid.\r
- *\r
- * \warning SOCKETS_Connect() is not safe to be called on the same socket\r
- * from multiple threads simultaneously with SOCKETS_Connect(),\r
- * SOCKETS_SetSockOpt(), SOCKETS_Shutdown(), SOCKETS_Close().\r
- *\r
- * See the [Berkeley Sockets API]\r
- * (https://en.wikipedia.org/wiki/Berkeley_sockets#Socket_API_functions)\r
- * in wikipedia\r
- *\r
- * @param[in] xSocket The handle of the socket to be connected.\r
- * @param[in] pxAddress A pointer to a SocketsSockaddr_t structure that contains the\r
- * the address to connect the socket to.\r
- * @param[in] xAddressLength Should be set to sizeof( @ref SocketsSockaddr_t ).\r
- *\r
- * @return\r
- * * @ref SOCKETS_ERROR_NONE if a connection is established.\r
- * * If an error occurred, a negative value is returned. @ref SocketsErrors\r
- */\r
-/* @[declare_secure_sockets_connect] */\r
-int32_t SOCKETS_Connect( Socket_t xSocket,\r
- SocketsSockaddr_t * pxAddress,\r
- Socklen_t xAddressLength );\r
-/* @[declare_secure_sockets_connect] */\r
-\r
-/**\r
- * @brief Receive data from a TCP socket.\r
- *\r
- * The socket must have already been created using a call to SOCKETS_Socket()\r
- * and connected to a remote socket using SOCKETS_Connect().\r
- *\r
- * See the [Berkeley Sockets API]\r
- * (https://en.wikipedia.org/wiki/Berkeley_sockets#Socket_API_functions)\r
- * in wikipedia\r
- *\r
- * @param[in] xSocket The handle of the socket from which data is being received.\r
- * @param[out] pvBuffer The buffer into which the received data will be placed.\r
- * @param[in] xBufferLength The maximum number of bytes which can be received.\r
- * pvBuffer must be at least xBufferLength bytes long.\r
- * @param[in] ulFlags Not currently used. Should be set to 0.\r
- *\r
- * @return\r
- * * If the receive was successful then the number of bytes received (placed in the\r
- * buffer pointed to by pvBuffer) is returned.\r
- * * If a timeout occurred before data could be received then 0 is returned (timeout\r
- * is set using @ref SOCKETS_SO_RCVTIMEO).\r
- * * If an error occurred, a negative value is returned. @ref SocketsErrors\r
- */\r
-/* @[declare_secure_sockets_recv] */\r
-int32_t SOCKETS_Recv( Socket_t xSocket,\r
- void * pvBuffer,\r
- size_t xBufferLength,\r
- uint32_t ulFlags );\r
-/* @[declare_secure_sockets_recv] */\r
-\r
-/**\r
- * @brief Transmit data to the remote socket.\r
- *\r
- * The socket must have already been created using a call to SOCKETS_Socket() and\r
- * connected to a remote socket using SOCKETS_Connect().\r
- *\r
- * See the [Berkeley Sockets API]\r
- * (https://en.wikipedia.org/wiki/Berkeley_sockets#Socket_API_functions)\r
- * in wikipedia\r
- *\r
- * @param[in] xSocket The handle of the sending socket.\r
- * @param[in] pvBuffer The buffer containing the data to be sent.\r
- * @param[in] xDataLength The length of the data to be sent.\r
- * @param[in] ulFlags Not currently used. Should be set to 0.\r
- *\r
- * @return\r
- * * On success, the number of bytes actually sent is returned.\r
- * * If an error occurred, a negative value is returned. @ref SocketsErrors\r
- */\r
-/* @[declare_secure_sockets_send] */\r
-int32_t SOCKETS_Send( Socket_t xSocket,\r
- const void * pvBuffer,\r
- size_t xDataLength,\r
- uint32_t ulFlags );\r
-/* @[declare_secure_sockets_send] */\r
-\r
-/**\r
- * @brief Closes all or part of a full-duplex connection on the socket.\r
- *\r
- * Disable reads and writes on a connected TCP socket. A connected TCP socket must be gracefully\r
- * shut down before it can be closed.\r
- *\r
- * See the [Berkeley Sockets API]\r
- * (https://en.wikipedia.org/wiki/Berkeley_sockets#Socket_API_functions)\r
- * in wikipedia\r
- *\r
- * \warning SOCKETS_Shutdown() is not safe to be called on the same socket\r
- * from multiple threads simultaneously with SOCKETS_Connect(),\r
- * SOCKETS_SetSockOpt(), SOCKETS_Shutdown(), SOCKETS_Close().\r
- *\r
- * @param[in] xSocket The handle of the socket to shutdown.\r
- * @param[in] ulHow SOCKETS_SHUT_RD, SOCKETS_SHUT_WR or SOCKETS_SHUT_RDWR.\r
- * @ref ShutdownFlags\r
- *\r
- * @return\r
- * * If the operation was successful, 0 is returned.\r
- * * If an error occurred, a negative value is returned. @ref SocketsErrors\r
- */\r
-/* @[declare_secure_sockets_shutdown] */\r
-int32_t SOCKETS_Shutdown( Socket_t xSocket,\r
- uint32_t ulHow );\r
-/* @[declare_secure_sockets_shutdown] */\r
-\r
-/**\r
- * @brief Closes the socket and frees the related resources.\r
- *\r
- * A socket should be shutdown gracefully before it is closed, and cannot be used after it has been closed.\r
- *\r
- * See the [Berkeley Sockets API]\r
- * (https://en.wikipedia.org/wiki/Berkeley_sockets#Socket_API_functions)\r
- * in wikipedia\r
- *\r
- * \warning SOCKETS_Close() is not safe to be called on the same socket\r
- * from multiple threads simultaneously with SOCKETS_Connect(),\r
- * SOCKETS_SetSockOpt(), SOCKETS_Shutdown(), SOCKETS_Close().\r
- *\r
- * @param[in] xSocket The handle of the socket to close.\r
- *\r
- * @return\r
- * * On success, 0 is returned.\r
- * * If an error occurred, a negative value is returned. @ref SocketsErrors\r
- */\r
-/* @[declare_secure_sockets_close] */\r
-int32_t SOCKETS_Close( Socket_t xSocket );\r
-/* @[declare_secure_sockets_close] */\r
-\r
-/**\r
- * @brief AWS IoT ALPN protocol name for MQTT over TLS on server port 443.\r
- */\r
-#define socketsAWS_IOT_ALPN_MQTT "x-amzn-mqtt-ca"\r
-\r
-/**\r
- * @brief Manipulates the options for the socket.\r
- *\r
- * See the [Berkeley Sockets API]\r
- * (https://en.wikipedia.org/wiki/Berkeley_sockets#Socket_API_functions)\r
- * in wikipedia\r
- *\r
- * @param[in] xSocket The handle of the socket to set the option for.\r
- * @param[in] lLevel Not currently used. Should be set to 0.\r
- * @param[in] lOptionName See @ref SetSockOptOptions.\r
- * @param[in] pvOptionValue A buffer containing the value of the option to set.\r
- * @param[in] xOptionLength The length of the buffer pointed to by pvOptionValue.\r
- *\r
- * \warning SOCKETS_Close() is not safe to be called on the same socket\r
- * from multiple threads simultaneously with SOCKETS_Connect(),\r
- * SOCKETS_SetSockOpt(), SOCKETS_Shutdown(), SOCKETS_Close().\r
- *\r
- * @note Socket option support and possible values vary by port. Please see\r
- * PORT_SPECIFIC_LINK to check the valid options and limitations of your device.\r
- *\r
- * - Berkeley Socket Options\r
- * - @ref SOCKETS_SO_RCVTIMEO\r
- * - Sets the receive timeout\r
- * - pvOptionValue (TickType_t) is the number of milliseconds that the\r
- * receive function should wait before timing out.\r
- * - Setting pvOptionValue = 0 causes receive to wait forever.\r
- * - See PORT_SPECIFIC_LINK for device limitations.\r
- * - @ref SOCKETS_SO_SNDTIMEO\r
- * - Sets the send timeout\r
- * - pvOptionValue (TickType_t) is the number of milliseconds that the\r
- * send function should wait before timing out.\r
- * - Setting pvOptionValue = 0 causes send to wait forever.\r
- * - See PORT_SPECIFIC_LINK for device limitations.\r
- * - Non-Standard Options\r
- * - @ref SOCKETS_SO_NONBLOCK\r
- * - Makes a socket non-blocking.\r
- * - Non-blocking connect is not supported - socket option should be\r
- * called after connect.\r
- * - pvOptionValue is ignored for this option.\r
- * - @ref SOCKETS_SO_WAKEUP_CALLBACK\r
- * - Set the callback to be called whenever there is data available on\r
- * the socket for reading\r
- * - This option provides an asynchronous way to handle received data\r
- * - pvOptionValue is a pointer to the callback function\r
- * - See PORT_SPECIFIC_LINK for device limitations.\r
- * - Security Sockets Options\r
- * - @ref SOCKETS_SO_REQUIRE_TLS\r
- * - Use TLS for all connect, send, and receive on this socket.\r
- * - This socket options MUST be set for TLS to be used, even\r
- * if other secure socket options are set.\r
- * - This socket option should be set before SOCKETS_Connect() is\r
- * called.\r
- * - pvOptionValue is ignored for this option.\r
- * - @ref SOCKETS_SO_TRUSTED_SERVER_CERTIFICATE\r
- * - Set the root of trust server certificate for the socket.\r
- * - This socket option only takes effect if @ref SOCKETS_SO_REQUIRE_TLS\r
- * is also set. If @ref SOCKETS_SO_REQUIRE_TLS is not set,\r
- * this option will be ignored.\r
- * - pvOptionValue is a pointer to the formatted server certificate.\r
- * TODO: Link to description of how to format certificates with \n\r
- * - xOptionLength (BaseType_t) is the length of the certificate\r
- * in bytes.\r
- * - @ref SOCKETS_SO_SERVER_NAME_INDICATION\r
- * - Use Server Name Indication (SNI)\r
- * - This socket option only takes effect if @ref SOCKETS_SO_REQUIRE_TLS\r
- * is also set. If @ref SOCKETS_SO_REQUIRE_TLS is not set,\r
- * this option will be ignored.\r
- * - pvOptionValue is a pointer to a string containing the hostname\r
- * - xOptionLength is the length of the hostname string in bytes.\r
- * - @ref SOCKETS_SO_ALPN_PROTOCOLS\r
- * - Negotiate an application protocol along with TLS.\r
- * - The ALPN list is expressed as an array of NULL-terminated ANSI\r
- * strings.\r
- * - xOptionLength is the number of items in the array.\r
- *\r
- * @return\r
- * * On success, 0 is returned.\r
- * * If an error occurred, a negative value is returned. @ref SocketsErrors\r
- */\r
-/* @[declare_secure_sockets_setsockopt] */\r
-int32_t SOCKETS_SetSockOpt( Socket_t xSocket,\r
- int32_t lLevel,\r
- int32_t lOptionName,\r
- const void * pvOptionValue,\r
- size_t xOptionLength );\r
-/* @[declare_secure_sockets_setsockopt] */\r
-\r
-/**\r
- * @brief Resolve a host name using Domain Name Service.\r
- *\r
- * See the [Berkeley Sockets API]\r
- * (https://en.wikipedia.org/wiki/Berkeley_sockets#Socket_API_functions)\r
- * in wikipedia\r
- *\r
- * @param[in] pcHostName The host name to resolve.\r
- * @return\r
- * * The IPv4 address of the specified host.\r
- * * If an error has occurred, 0 is returned.\r
- */\r
-/* @[declare_secure_sockets_gethostbyname] */\r
-uint32_t SOCKETS_GetHostByName( const char * pcHostName );\r
-/* @[declare_secure_sockets_gethostbyname] */\r
-\r
-\r
-\r
-/**\r
- * @brief Convert an unsigned thirty-two-bit value from host endianness to network\r
- * endianness.\r
- *\r
- * @param[in] usIn The unsigned thirty-two-bit value to convert.\r
- */\r
-#if defined( socketsconfigBYTE_ORDER ) && ( socketsconfigBYTE_ORDER == pdLITTLE_ENDIAN )\r
- #define SOCKETS_htonl( ulIn ) ( ( uint32_t ) ( ( ( ulIn & 0xFF ) << 24 ) | ( ( ulIn & 0xFF00 ) << 8 ) | ( ( ulIn & 0xFF0000 ) >> 8 ) | ( ( ulIn & 0xFF000000 ) >> 24 ) ) )\r
-#else\r
- #define SOCKETS_htonl( usIn ) ( ( uint32_t ) ( usIn ) )\r
-#endif\r
-\r
-/**\r
- * @brief Convert an unsigned thirty-two-bit value from network endianness to host\r
- * endianness.\r
- *\r
- * @param[in] usIn The unsigned thirty-two-bit value to convert.\r
- */\r
-#define SOCKETS_ntohl( usIn ) SOCKETS_htonl( usIn )\r
-\r
-\r
-/**\r
- * @brief Convert an unsigned sixteen-bit value from host endianness to network\r
- * endianness.\r
- *\r
- * @param[in] usIn The unsigned sixteen-bit value to convert.\r
- */\r
-\r
-#if defined( socketsconfigBYTE_ORDER ) && ( socketsconfigBYTE_ORDER == pdLITTLE_ENDIAN )\r
- #define SOCKETS_htons( usIn ) ( ( uint16_t ) ( ( ( usIn ) << 8U ) | ( ( usIn ) >> 8U ) ) )\r
-#else\r
- #define SOCKETS_htons( usIn ) ( ( uint16_t ) ( usIn ) )\r
-#endif\r
-\r
-\r
-/**\r
- * @brief Convert an unsigned sixteen-bit value from network endianness to host\r
- * endianness.\r
- *\r
- * @param[in] usIn The unsigned sixteen-bit value to convert.\r
- */\r
-#define SOCKETS_ntohs( usIn ) SOCKETS_htons( usIn )\r
-\r
-/**\r
- * @brief Convert an IP address expressed as four separate numeric octets into a an IP address expressed as a 32-bit number in network byte order\r
- * (for example 192, 168, 0, 100)\r
- *\r
- * @param[in] ucOctet0 0th IP Octet\r
- * @param[in] ucOctet1 1st IP Octet\r
- * @param[in] ucOctet2 2nd IP Octet\r
- * @param[in] ucOctet3 3rd IP Octet\r
- */\r
-#if defined( socketsconfigBYTE_ORDER ) && ( socketsconfigBYTE_ORDER == pdLITTLE_ENDIAN )\r
-\r
- #define SOCKETS_inet_addr_quick( ucOctet0, ucOctet1, ucOctet2, ucOctet3 ) \\r
- ( ( ( ( uint32_t ) ( ucOctet3 ) ) << 24UL ) | \\r
- ( ( ( uint32_t ) ( ucOctet2 ) ) << 16UL ) | \\r
- ( ( ( uint32_t ) ( ucOctet1 ) ) << 8UL ) | \\r
- ( ( uint32_t ) ( ucOctet0 ) ) )\r
-\r
-/**\r
- * @brief Convert an IP address expressed as a 32-bit number in network byte order to a string in decimal dot notation.\r
- * (for example "192.168.0.100")\r
- *\r
- * @param[in] ulIPAddress An IP address expressed as a 32-bit value in network byte order.\r
- * @param[in] pucBuffer A pointer to a buffer into which the IP address will be written in decimal dot notation.\r
- */\r
- #define SOCKETS_inet_ntoa( ulIPAddress, pucBuffer ) \\r
- sprintf( ( char * ) ( pucBuffer ), "%u.%u.%u.%u", \\r
- ( ( unsigned ) ( ( ulIPAddress ) & 0xffUL ) ), \\r
- ( ( unsigned ) ( ( ( ulIPAddress ) >> 8 ) & 0xffUL ) ), \\r
- ( ( unsigned ) ( ( ( ulIPAddress ) >> 16 ) & 0xffUL ) ), \\r
- ( ( unsigned ) ( ( ulIPAddress ) >> 24 ) ) )\r
-\r
-#else /* socketsconfigBYTE_ORDER. */\r
-\r
- #define SOCKETS_inet_addr_quick( ucOctet0, ucOctet1, ucOctet2, ucOctet3 ) \\r
- ( ( ( ( uint32_t ) ( ucOctet0 ) ) << 24UL ) | \\r
- ( ( ( uint32_t ) ( ucOctet1 ) ) << 16UL ) | \\r
- ( ( ( uint32_t ) ( ucOctet2 ) ) << 8UL ) | \\r
- ( ( uint32_t ) ( ucOctet3 ) ) )\r
-\r
-/**\r
- * @brief Convert an IP address expressed as a 32-bit number in network byte order to a string in decimal dot notation.\r
- * (for example "192.168.0.100")\r
- *\r
- * @param[in] ulIPAddress An IP address expressed as a 32-bit value in network byte order.\r
- * @param[in] pucBuffer A pointer to a buffer into which the IP address will be written in decimal dot notation.\r
- */\r
- #define SOCKETS_inet_ntoa( ulIPAddress, pucBuffer ) \\r
- sprintf( ( char * ) ( pucBuffer ), "%u.%u.%u.%u", \\r
- ( ( unsigned ) ( ( ulIPAddress ) >> 24 ) ), \\r
- ( ( unsigned ) ( ( ( ulIPAddress ) >> 16 ) & 0xffUL ) ), \\r
- ( ( unsigned ) ( ( ( ulIPAddress ) >> 8 ) & 0xffUL ) ), \\r
- ( ( unsigned ) ( ( ulIPAddress ) & 0xffUL ) ) )\r
-\r
-#endif /* socketsconfigBYTE_ORDER. */\r
-\r
-/*\r
- #ifdef __cplusplus\r
- * }\r
- #endif\r
- */\r
-\r
-#endif /* _AWS_SECURE_SOCKETS_H_ */\r