git.sur5r.net Git - freertos/blob - FreeRTOS-Plus/Source/FreeRTOS-IoT-Libraries/abstractions/secure_sockets/include/iot_secure_sockets_config_defaults.h

   1 /*\r
   2  * Amazon FreeRTOS Secure Sockets V1.1.5\r
   3  * Copyright (C) 2018 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software.\r
  14  *\r
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  21  *\r
  22  * http://aws.amazon.com/freertos\r
  23  * http://www.FreeRTOS.org\r
  24  */\r
  25 \r
  26 /**\r
  27  * @file iot_secure_sockets_config_defaults.h\r
  28  * @brief Ensures that the required sockets configuration options are supplied\r
  29  * and the optional ones are set to sane values if the user does not supply.\r
  30  */\r
  31 \r
  32 #ifndef AWS_INC_SECURE_SOCKETS_CONFIG_DEFAULTS_H_\r
  33 #define AWS_INC_SECURE_SOCKETS_CONFIG_DEFAULTS_H_\r
  34 \r
  35 /**\r
  36  * @brief Byte order of the target MCU must be defined.\r
  37  *\r
  38  * Valid values are pdLITTLE_ENDIAN and pdBIG_ENDIAN.\r
  39  */\r
  40 #ifndef socketsconfigBYTE_ORDER\r
  41     #error "socketsconfigBYTE_ORDER must be defined."\r
  42 #endif\r
  43 \r
  44 /**\r
  45  * @brief Default socket send timeout.\r
  46  *\r
  47  * The user can change the send timeout for a socket using the SOCKETS_SetSockOpt API\r
  48  * with the SOCKETS_SO_SNDTIMEO option.\r
  49  */\r
  50 #ifndef socketsconfigDEFAULT_SEND_TIMEOUT\r
  51     #define socketsconfigDEFAULT_SEND_TIMEOUT    ( 10000 )\r
  52 #endif\r
  53 \r
  54 /**\r
  55  * @brief Default socket receive timeout.\r
  56  *\r
  57  * The user can change the receive timeout for a socket using the SOCKETS_SetSockOpt API\r
  58  * with the SOCKETS_SO_RCVTIMEO option.\r
  59  */\r
  60 #ifndef socketsconfigDEFAULT_RECV_TIMEOUT\r
  61     #define socketsconfigDEFAULT_RECV_TIMEOUT    ( 10000 )\r
  62 #endif\r
  63 \r
  64 /**\r
  65  * @brief By default, metrics of secure socket is disabled.\r
  66  *\r
  67  */\r
  68 #ifndef AWS_IOT_SECURE_SOCKETS_METRICS_ENABLED\r
  69     #define AWS_IOT_SECURE_SOCKETS_METRICS_ENABLED    ( 0 )\r
  70 #endif\r
  71 \r
  72 #endif /* AWS_INC_SECURE_SOCKETS_CONFIG_DEFAULTS_H_ */\r