+++ /dev/null
-/*\r
- * Amazon FreeRTOS MQTT V2.0.0\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_mqtt_lib.h\r
- * @brief MQTT Core Library interface.\r
- */\r
-\r
-#ifndef _AWS_MQTT_LIB_H_\r
-#define _AWS_MQTT_LIB_H_\r
-\r
-/* This ifndef enables the core MQTT library to be used without\r
- * providing MQTTConfig.h. All the config values in this case are\r
- * taken from MQTTConfigDefaults.h. */\r
-#ifndef mqttDO_NOT_USE_CUSTOM_CONFIG\r
- #include "aws_mqtt_config.h"\r
-#endif\r
-#include "iot_mqtt_config_defaults.h"\r
-\r
-#include "iot_doubly_linked_list.h"\r
-\r
- /**\r
- * @brief Opaque handle to represent an MQTT buffer.\r
- */\r
-typedef void * MQTTBufferHandle_t;\r
-\r
-/**\r
- * @brief Boolean type.\r
- */\r
-typedef enum\r
-{\r
- eMQTTFalse = 0, /**< Boolean False. */\r
- eMQTTTrue = 1 /**< Boolean True. */\r
-} MQTTBool_t;\r
-\r
-/**\r
- * @brief Quality of Service (qos).\r
- */\r
-typedef enum\r
-{\r
- eMQTTQoS0 = 0, /**< Quality of Service 0 - Fire and Forget. No ACK. */\r
- eMQTTQoS1 = 1, /**< Quality of Service 1 - Wait till ACK or Timeout. */\r
- eMQTTQoS2 = 2 /**< Quality of Service 2 - Not supported. */\r
-} MQTTQoS_t;\r
-\r
-/**\r
- * @brief The data sent by the MQTT library in the user supplied callback\r
- * when a publish message from the broker is received.\r
- */\r
-typedef struct MQTTPublishData\r
-{\r
- MQTTQoS_t xQos; /**< Quality of Service (qos). */\r
- const uint8_t * pucTopic; /**< The topic on which the message is received. */\r
- uint16_t usTopicLength; /**< Length of the topic. */\r
- const void * pvData; /**< The received message. */\r
- uint32_t ulDataLength; /**< Length of the message. */\r
- MQTTBufferHandle_t xBuffer; /**< The buffer containing the whole MQTT message. Both pcTopic and pvData are pointers to the locations in this buffer. */\r
-} MQTTPublishData_t;\r
-\r
-/**\r
- * @brief Signature of the user supplied topic specific publish callback which gets called\r
- * whenever a publish message is received on the topic this callback is registered for.\r
- *\r
- * The user can choose to register this optional topic specific callback while subscribing to\r
- * a topic. Whenever a publish message is received on the topic, this callback is invoked. If\r
- * the user chooses not to enable subscription management or chooses not to register a topic\r
- * specific callback, the generic callback supplied during Init is invoked.\r
- *\r
- * @param[in] pvPublishCallbackContext The callback context as supplied by the user in the\r
- * subscribe parameters.\r
- * @param[in] pxPublishData The publish data.\r
- *\r
- * @return The return value is interpreted as follows:\r
- * 1. If eMQTTTrue is returned - the ownership of the buffer passed in the callback (xBuffer\r
- * in MQTTPublishData_t) lies with the user.\r
- * 2. If eMQTTFalse is returned - the ownership of the buffer passed in the callback (xBuffer\r
- * in MQTTPublishData_t) remains with the library and it is recycled as soon as the callback\r
- * returns.<br>\r
- * The user should take the ownership of the buffer containing the received message from the\r
- * broker by returning eMQTTTrue from the callback if the user wants to use the buffer after\r
- * the callback is over. The user should return the buffer whenever done by calling the\r
- * MQTT_ReturnBuffer API.\r
- */\r
-#if ( mqttconfigENABLE_SUBSCRIPTION_MANAGEMENT == 1 )\r
-\r
- typedef MQTTBool_t ( * MQTTPublishCallback_t )( void * pvPublishCallbackContext,\r
- const MQTTPublishData_t * const pxPublishData );\r
-\r
-#endif /* mqttconfigENABLE_SUBSCRIPTION_MANAGEMENT */\r
-\r
-#endif /* _AWS_MQTT_LIB_H_ */\r
projects / freertos / blobdiff