/* * Copyright (C) 2020 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. */ #ifndef CORE_MQTT_CONFIG_H_ #define CORE_MQTT_CONFIG_H_ /**************************************************/ /******* DO NOT CHANGE the following order ********/ /**************************************************/ /* Include logging header files and define logging macros in the following order: * 1. Include the header file "logging_levels.h". * 2. Define the LIBRARY_LOG_NAME and LIBRARY_LOG_LEVEL macros depending on * the logging configuration for MQTT. * 3. Include the header file "logging_stack.h", if logging is enabled for MQTT. */ #include "logging_levels.h" /* Logging configuration for the MQTT library. */ #ifndef LIBRARY_LOG_NAME #define LIBRARY_LOG_NAME "MQTT" #endif #ifndef LIBRARY_LOG_LEVEL #define LIBRARY_LOG_LEVEL LOG_INFO #endif #include "logging_stack.h" /************ End of logging configuration ****************/ /** * @brief The maximum number of MQTT PUBLISH messages that may be pending * acknowledgement at any time. * * QoS 1 and 2 MQTT PUBLISHes require acknowledgement from the server before * they can be completed. While they are awaiting the acknowledgement, the * client must maintain information about their state. The value of this * macro sets the limit on how many simultaneous PUBLISH states an MQTT * context maintains. */ #define MQTT_STATE_ARRAY_MAX_COUNT ( 10U ) /** * @brief Number of milliseconds to wait for a ping response to a ping * request as part of the keep-alive mechanism. * * If a ping response is not received before this timeout, then * #MQTT_ProcessLoop will return #MQTTKeepAliveTimeout. */ #define MQTT_PINGRESP_TIMEOUT_MS ( 5000U ) #define MQTT_AGENT_COMMAND_QUEUE_LENGTH ( 25 ) #define MQTT_COMMAND_CONTEXTS_POOL_SIZE ( 10 ) /** * @brief The maximum number of subscriptions to track for a single connection. * * @note The MQTT agent keeps a record of all existing MQTT subscriptions. * MQTT_AGENT_MAX_SIMULTANEOUS_SUBSCRIPTIONS sets the maximum number of * subscriptions records that can be maintained at one time. The higher this * number is the greater the agent's RAM consumption will be. */ #define MQTT_AGENT_MAX_SIMULTANEOUS_SUBSCRIPTIONS ( 10 ) /** * @brief Size of statically allocated buffers for holding subscription filters. * * @note Subscription filters are strings such as "/my/topicname/#". These * strings are limited to a maximum of MQTT_AGENT_MAX_SUBSCRIPTION_FILTER_LENGTH * characters. The higher this number is the greater the agent's RAM consumption * will be. */ #define MQTT_AGENT_MAX_SUBSCRIPTION_FILTER_LENGTH ( 100 ) /** * @brief Dimensions the buffer used to serialize and deserialize MQTT packets. * @note Specified in bytes. Must be large enough to hold the maximum * anticipated MQTT payload. */ #define MQTT_AGENT_NETWORK_BUFFER_SIZE ( 5000 ) #endif /* ifndef CORE_MQTT_CONFIG_H_ */