v2.3.3发布

1. 优化MQTT PING request发包策略。
2. 优化错误码类型。
3. 修复MQTT获取sys及log消息的问题。

Author: spikelin

src/mqtt/include/mqtt_client.h

@@ -374,7 +374,7 @@ uint16_t get_next_packet_id(Qcloud_IoT_Client *pClient);
  * @param options
  * @return
  */
-void get_next_conn_id(MQTTConnectParams *options);
+void get_next_conn_id(char *conn_id);
 
 /**
  *

src/mqtt/src/mqtt_client.c

@@ -48,7 +48,6 @@ static int s_qcloud_iot_port = 8883;
 static unsigned char sg_psk_str[DECODE_PSK_LENGTH];
 #endif
 
-#define min(a,b) (a) < (b) ? (a) : (b)
 
 
 static uint16_t _get_random_start_packet_id(void)
@@ -88,7 +87,7 @@ void* IOT_MQTT_Construct(MQTTInitParams *pParams)
 	MQTTConnectParams connect_params = DEFAULT_MQTTCONNECT_PARAMS;
 	connect_params.client_id = iot_device_info_get()->client_id;
     // 超过11.5分钟的心跳间隔自动转为11.5（11.5 * 60）的时长
-	connect_params.keep_alive_interval = min(pParams->keep_alive_interval_ms / 1000, 690);
+	connect_params.keep_alive_interval = Min(pParams->keep_alive_interval_ms / 1000, 690);
 	connect_params.clean_session = pParams->clean_session;
 	connect_params.auto_connect_enable = pParams->auto_connect_enable;
 #if defined(AUTH_WITH_NOTLS) && defined(AUTH_MODE_KEY)

src/mqtt/src/mqtt_client_common.c

@@ -65,25 +65,25 @@ uint16_t get_next_packet_id(Qcloud_IoT_Client *pClient) {
     IOT_FUNC_EXIT_RC(pClient->next_packet_id);
 }
 
-void get_next_conn_id(MQTTConnectParams *options) {
+void get_next_conn_id(char *conn_id) {
 	int i;
 	srand((unsigned)time(0));
 	for (i = 0; i < MAX_CONN_ID_LEN - 1; i++) {
 		int flag = rand() % 3;
 		switch(flag) {
 			case 0:
-				options->conn_id[i] = (rand() % 26) + 'a';
+				conn_id[i] = (rand() % 26) + 'a';
 				break;
 			case 1:
-				options->conn_id[i] = (rand() % 26) + 'A';
+				conn_id[i] = (rand() % 26) + 'A';
 				break;
 			case 2:
-				options->conn_id[i] = (rand() % 10) + '0';
+				conn_id[i] = (rand() % 10) + '0';
 				break;
 		}
 	}
 
-	options->conn_id[MAX_CONN_ID_LEN - 1] = '\0';
+	conn_id[MAX_CONN_ID_LEN - 1] = '\0';
 }
 
 /**
@@ -1334,15 +1334,16 @@ int cycle_for_read(Qcloud_IoT_Client *pClient, Timer *timer, uint8_t *packet_typ
         }
     }
 
-    /* Receiving below msgs are all considered as PING OK */
     switch (*packet_type) {        
+        /* Recv below msgs are all considered as PING OK */
         case PUBACK:
         case SUBACK:
         case UNSUBACK:        
         case PINGRESP: {
             _handle_pingresp_packet(pClient);
             break;
         }
+        /* Recv downlink pub means link is OK but we still need to send PING request */
         case PUBLISH: {
             HAL_MutexLock(pClient->lock_generic);    
             pClient->is_ping_outstanding = 0;

src/mqtt/src/mqtt_client_connect.c

@@ -128,7 +128,7 @@ static int _serialize_connect_packet(unsigned char *buf, size_t buf_len, MQTTCon
 
     int username_len = strlen(options->client_id) + strlen(QCLOUD_IOT_DEVICE_SDK_APPID) + MAX_CONN_ID_LEN + cur_timesec_len + 4;
     options->username = (char*)HAL_Malloc(username_len);
-    get_next_conn_id(options);
+    get_next_conn_id(options->conn_id);
 	HAL_Snprintf(options->username, username_len, "%s;%s;%s;%ld", options->client_id, QCLOUD_IOT_DEVICE_SDK_APPID, options->conn_id, cur_timesec);
 
 #if defined(AUTH_WITH_NOTLS) && defined(AUTH_MODE_KEY)

src/mqtt/src/mqtt_client_yield.c

@@ -132,7 +132,7 @@ static int _handle_reconnect(Qcloud_IoT_Client *pClient) {
  */
 static int _mqtt_keep_alive(Qcloud_IoT_Client *pClient)
 {
-#define MQTT_PING_TIMES_IN_KEEPALIVE_INTERVAL   2
+#define MQTT_PING_RETRY_TIMES   2
 
     IOT_FUNC_ENTRY;
 
@@ -148,7 +148,7 @@ static int _mqtt_keep_alive(Qcloud_IoT_Client *pClient)
         IOT_FUNC_EXIT_RC(QCLOUD_ERR_SUCCESS);
     }
 
-    if (pClient->is_ping_outstanding >= MQTT_PING_TIMES_IN_KEEPALIVE_INTERVAL) {
+    if (pClient->is_ping_outstanding >= MQTT_PING_RETRY_TIMES) {
         //Reaching here means we haven't received any MQTT packet for a long time (keep_alive_interval)
         Log_e("Fail to recv MQTT msg. Something wrong with the connection.");
         rc = _handle_disconnect(pClient);
@@ -183,7 +183,7 @@ static int _mqtt_keep_alive(Qcloud_IoT_Client *pClient)
     HAL_MutexLock(pClient->lock_generic);
     pClient->is_ping_outstanding++;
     /* start a timer to wait for PINGRESP from server */
-    countdown(&pClient->ping_timer, pClient->options.keep_alive_interval/MQTT_PING_TIMES_IN_KEEPALIVE_INTERVAL);
+    countdown(&pClient->ping_timer, Min(5, pClient->options.keep_alive_interval/2));
     HAL_MutexUnlock(pClient->lock_generic);
     Log_d("PING request %u has been sent...", pClient->is_ping_outstanding);
 

src/nbiot/src/nbiot_client.c

@@ -34,7 +34,7 @@ typedef enum tlvType {
 
 int toBigEnd32(unsigned char* buf, uint32_t x)
 {
-    POINTER_SANITY_CHECK(buf, QCLOUD_ERR_NULL);
+    POINTER_SANITY_CHECK(buf, QCLOUD_ERR_INVAL);
 
     buf[0] = (x >> 24) & 0xFF;
     buf[1] = (x >> 16) & 0xFF;
@@ -46,7 +46,7 @@ int toBigEnd32(unsigned char* buf, uint32_t x)
 
 int toBigEnd16(unsigned char* buf, uint16_t x)
 {
-    POINTER_SANITY_CHECK(buf, QCLOUD_ERR_NULL);
+    POINTER_SANITY_CHECK(buf, QCLOUD_ERR_INVAL);
 
     *buf = ((x) & 0xFF00) >> 8 ;
     *(buf+1) = (x) & 0xFF ;
@@ -57,8 +57,8 @@ int toBigEnd16(unsigned char* buf, uint16_t x)
 
 int ntohBig32(uint32_t* x, unsigned char* buf)
 {
-    POINTER_SANITY_CHECK(x, QCLOUD_ERR_NULL);
-    POINTER_SANITY_CHECK(buf, QCLOUD_ERR_NULL);
+    POINTER_SANITY_CHECK(x, QCLOUD_ERR_INVAL);
+    POINTER_SANITY_CHECK(buf, QCLOUD_ERR_INVAL);
 
     *x = (buf[0] << 24) + (buf[1] << 16) + (buf[2] << 8) + buf[3];
 
@@ -67,8 +67,8 @@ int ntohBig32(uint32_t* x, unsigned char* buf)
 
 int ntohBig16(uint16_t* x, unsigned char* buf)
 {
-    POINTER_SANITY_CHECK(x, QCLOUD_ERR_NULL);
-    POINTER_SANITY_CHECK(buf, QCLOUD_ERR_NULL);
+    POINTER_SANITY_CHECK(x, QCLOUD_ERR_INVAL);
+    POINTER_SANITY_CHECK(buf, QCLOUD_ERR_INVAL);
 
     *x = (buf[0] << 8) + buf[1];
 
@@ -97,10 +97,10 @@ void StrToHex(char *pbDest, char *pbSrc, int nLen)
 
 int calToken(char* token, int* tokenSize, const unsigned char* keyBase64, char* topic, uint32_t expiry, uint8_t qos, char* payload)
 {
-    POINTER_SANITY_CHECK(token, QCLOUD_ERR_NULL);
-    POINTER_SANITY_CHECK(keyBase64, QCLOUD_ERR_NULL);
-    POINTER_SANITY_CHECK(topic, QCLOUD_ERR_NULL);
-    POINTER_SANITY_CHECK(payload, QCLOUD_ERR_NULL);
+    POINTER_SANITY_CHECK(token, QCLOUD_ERR_INVAL);
+    POINTER_SANITY_CHECK(keyBase64, QCLOUD_ERR_INVAL);
+    POINTER_SANITY_CHECK(topic, QCLOUD_ERR_INVAL);
+    POINTER_SANITY_CHECK(payload, QCLOUD_ERR_INVAL);
 
     size_t len = 0;
 
@@ -148,8 +148,8 @@ int calToken(char* token, int* tokenSize, const unsigned char* keyBase64, char*
 
 int addTLV(unsigned char* buf, uint8_t type, char* value)
 {
-    POINTER_SANITY_CHECK(buf, QCLOUD_ERR_NULL);
-    POINTER_SANITY_CHECK(value, QCLOUD_ERR_NULL);
+    POINTER_SANITY_CHECK(buf, QCLOUD_ERR_INVAL);
+    POINTER_SANITY_CHECK(value, QCLOUD_ERR_INVAL);
     unsigned char* ptr = buf;
     uint16_t length = strlen(value);
 
@@ -171,9 +171,9 @@ int addTLV(unsigned char* buf, uint8_t type, char* value)
 
 int IOT_NB_setMessage(unsigned char* msg, unsigned int* length, NBIoTSetMessage* nbiotMsg)
 {
-    POINTER_SANITY_CHECK(msg, QCLOUD_ERR_NULL);
-    POINTER_SANITY_CHECK(length, QCLOUD_ERR_NULL);
-    POINTER_SANITY_CHECK(nbiotMsg, QCLOUD_ERR_NULL);
+    POINTER_SANITY_CHECK(msg, QCLOUD_ERR_INVAL);
+    POINTER_SANITY_CHECK(length, QCLOUD_ERR_INVAL);
+    POINTER_SANITY_CHECK(nbiotMsg, QCLOUD_ERR_INVAL);
 
     uint16_t v1Size = strlen(nbiotMsg->topic);
     if( v1Size > MAX_SIZE_TOPIC )
@@ -267,8 +267,8 @@ int IOT_NB_setMessage(unsigned char* msg, unsigned int* length, NBIoTSetMessage*
 
 int IOT_NB_getMessage(NBIoTGetMessage* nbiotMsg, unsigned char* msg)
 {
-    POINTER_SANITY_CHECK(nbiotMsg, QCLOUD_ERR_NULL);
-    POINTER_SANITY_CHECK(msg, QCLOUD_ERR_NULL);
+    POINTER_SANITY_CHECK(nbiotMsg, QCLOUD_ERR_INVAL);
+    POINTER_SANITY_CHECK(msg, QCLOUD_ERR_INVAL);
 
     size_t len = 0;
     //uint16_t u16Temp = 0;
@@ -392,4 +392,4 @@ int IOT_NB_getMessage(NBIoTGetMessage* nbiotMsg, unsigned char* msg)
 
 
     return QCLOUD_ERR_SUCCESS;
-}
+}

src/sdk-impl/exports/qcloud_iot_export_error.h

@@ -42,7 +42,6 @@ typedef enum {
     QCLOUD_ERR_SUCCESS                                       = 0,       // 表示成功返回
     QCLOUD_ERR_FAILURE                                       = -1001,   // 表示失败返回
     QCLOUD_ERR_INVAL                                         = -1002,   // 表示参数无效错误
-    QCLOUD_ERR_NULL                                          = -1003,   // 表示空指针
 
     QCLOUD_ERR_MQTT_PUSH_TO_LIST_FAILED                      = -102,    // 表示往等待 ACK 列表中添加元素失败
     QCLOUD_ERR_MQTT_NO_CONN                                  = -103,    // 表示未与MQTT服务器建立连接或已经断开连接

src/sdk-impl/qcloud_iot_import.h

@@ -33,6 +33,10 @@ extern "C" {
 #define IOT_TRUE    (1)     /* indicate boolean value true */
 #define IOT_FALSE   (0)     /* indicate boolean value false */
 
+#define Max(a,b) ((a) > (b) ? (a) : (b))
+#define Min(a,b) ((a) < (b) ? (a) : (b))
+
+
 /**
  * @brief 创建互斥锁
  *

src/system/src/log_mqtt.c

@@ -22,7 +22,6 @@
 #include "device.h"
 #include "log_upload.h"
 
-#define min(a,b) (a) < (b) ? (a) : (b)
 
 static bool sg_log_recv_ok   = false;
 static bool sg_log_sub_ok   = false;
@@ -54,7 +53,7 @@ static void _log_level_sub_cb(void *pClient, MQTTMessage *message, void *userDat
 		return;
 	}
 
-    json_buf_len = min(LOG_JSON_LENGTH - 1, message->payload_len);
+    json_buf_len = Min(LOG_JSON_LENGTH - 1, message->payload_len);
 	memcpy(json_buf, message->payload, json_buf_len);
 	json_buf[json_buf_len] = '\0';    // json_parse relies on a string
 
@@ -125,11 +124,11 @@ static void _log_mqtt_event_handler(void *pclient, void *handle_context, MQTTEve
 
 static int _iot_log_level_get_publish(void *pClient)
 {
-    POINTER_SANITY_CHECK(pClient, QCLOUD_ERR_NULL);
+    POINTER_SANITY_CHECK(pClient, QCLOUD_ERR_INVAL);
 
     Qcloud_IoT_Client   *mqtt_client = (Qcloud_IoT_Client *)pClient;
     DeviceInfo          *dev_info = iot_device_info_get();
-    POINTER_SANITY_CHECK(dev_info, QCLOUD_ERR_NULL);
+    POINTER_SANITY_CHECK(dev_info, QCLOUD_ERR_INVAL);
 
     char topic_name[128] = {0};
     char payload_content[128] = {0};
@@ -173,7 +172,7 @@ int qcloud_get_log_level(void* pClient, int *log_level)
     int cntSub = 0;
     int cntRev = 0;
 
-    POINTER_SANITY_CHECK(pClient, QCLOUD_ERR_NULL);
+    POINTER_SANITY_CHECK(pClient, QCLOUD_ERR_INVAL);
     Qcloud_IoT_Client   *mqtt_client = (Qcloud_IoT_Client *)pClient;
 
     //如果第一次订阅$log/operation/get/${productid}/${devicename}, 则执行订阅操作
@@ -204,6 +203,7 @@ int qcloud_get_log_level(void* pClient, int *log_level)
         return QCLOUD_ERR_FAILURE;
     }
 
+    sg_log_recv_ok = false;
     // 发布获取时间
 	ret = _iot_log_level_get_publish(mqtt_client);
 	if (ret < 0) {

src/system/src/system_mqtt.c

@@ -92,11 +92,11 @@ static void system_mqtt_event_handler(void *pclient, void *handle_context, MQTTE
 
 static int _iot_system_info_get_publish(void *pClient)
 {
-    POINTER_SANITY_CHECK(pClient, QCLOUD_ERR_NULL);
+    POINTER_SANITY_CHECK(pClient, QCLOUD_ERR_INVAL);
 
     Qcloud_IoT_Client   *mqtt_client = (Qcloud_IoT_Client *)pClient;
     DeviceInfo          *dev_info = iot_device_info_get();
-    POINTER_SANITY_CHECK(dev_info, QCLOUD_ERR_NULL);
+    POINTER_SANITY_CHECK(dev_info, QCLOUD_ERR_INVAL);
 
     char topic_name[128] = {0};
     char payload_content[128] = {0};
@@ -114,10 +114,10 @@ static int _iot_system_info_get_publish(void *pClient)
 
 static int _iot_system_info_result_subscribe(void *pClient, OnMessageHandler pCallback)
 {
-    POINTER_SANITY_CHECK(pClient, QCLOUD_ERR_NULL);
+    POINTER_SANITY_CHECK(pClient, QCLOUD_ERR_INVAL);
 
     DeviceInfo          *dev_info = iot_device_info_get();
-    POINTER_SANITY_CHECK(dev_info, QCLOUD_ERR_NULL);
+    POINTER_SANITY_CHECK(dev_info, QCLOUD_ERR_INVAL);
 
     char topic_name[128] = {0};
     int size = HAL_Snprintf(topic_name, sizeof(topic_name), "$sys/operation/result/%s/%s", dev_info->product_id, dev_info->device_name);
@@ -138,7 +138,7 @@ int IOT_SYSTEM_GET_TIME(void* pClient, long *time)
     int cntSub = 0;
     int cntRev = 0;
 
-    POINTER_SANITY_CHECK(pClient, QCLOUD_ERR_NULL);
+    POINTER_SANITY_CHECK(pClient, QCLOUD_ERR_INVAL);
     Qcloud_IoT_Client   *mqtt_client = (Qcloud_IoT_Client *)pClient;
 
     //如果第一次订阅$sys/operation/get/${productid}/${devicename}, 则执行订阅操作
@@ -169,6 +169,7 @@ int IOT_SYSTEM_GET_TIME(void* pClient, long *time)
         return QCLOUD_ERR_FAILURE;
     }
 
+    sg_sys_recv_ok = false;
     // 发布获取时间
 	ret = _iot_system_info_get_publish(mqtt_client);
 	if (ret < 0) {