Release of version 1.4.8

liuszeng · liuszeng · commit b2c6a120c8a7 · 2019-10-22T20:36:17.000Z
diff --git a/.gitignore b/.gitignore
diff --git a/AWSIoTPythonSDK/__init__.py b/AWSIoTPythonSDK/__init__.py
@@ -1,3 +1,3 @@
-__version__ = "1.4.7"
+__version__ = "1.4.8"
 
 
diff --git a/AWSIoTPythonSDK/core/protocol/internal/workers.py b/AWSIoTPythonSDK/core/protocol/internal/workers.py
@@ -187,11 +187,11 @@ def _handle_resubscribe(self):
         if subscriptions and not self._has_user_disconnect_request():
             self._logger.debug("Start resubscribing")
             self._client_status.set_status(ClientStatus.RESUBSCRIBE)
-            for topic, (qos, message_callback) in subscriptions:
+            for topic, (qos, message_callback, ack_callback) in subscriptions:
                 if self._has_user_disconnect_request():
                     self._logger.debug("User disconnect detected")
                     break
-                self._internal_async_client.subscribe(topic, qos)
+                self._internal_async_client.subscribe(topic, qos, ack_callback)
 
     def _handle_draining(self):
         if self._offline_requests_manager.has_more() and not self._has_user_disconnect_request():
@@ -232,7 +232,7 @@ def _dispatch_message(self, mid, message):
         self._logger.debug("Dispatching [message] event")
         subscriptions = self._subscription_manager.list_records()
         if subscriptions:
-            for topic, (qos, message_callback) in subscriptions:
+            for topic, (qos, message_callback, _) in subscriptions:
                 if topic_matches_sub(topic, message.topic) and message_callback:
                     message_callback(None, None, message)  # message_callback(client, userdata, message)
 
@@ -243,7 +243,7 @@ def _handle_offline_publish(self, request):
 
     def _handle_offline_subscribe(self, request):
         topic, qos, message_callback, ack_callback = request.data
-        self._subscription_manager.add_record(topic, qos, message_callback)
+        self._subscription_manager.add_record(topic, qos, message_callback, ack_callback)
         self._internal_async_client.subscribe(topic, qos, ack_callback)
         self._logger.debug("Processed offline subscribe request")
 
@@ -261,9 +261,9 @@ class SubscriptionManager(object):
     def __init__(self):
         self._subscription_map = dict()
 
-    def add_record(self, topic, qos, message_callback):
+    def add_record(self, topic, qos, message_callback, ack_callback):
         self._logger.debug("Adding a new subscription record: %s qos: %d", topic, qos)
-        self._subscription_map[topic] = qos, message_callback  # message_callback could be None
+        self._subscription_map[topic] = qos, message_callback, ack_callback  # message_callback and/or ack_callback could be None
 
     def remove_record(self, topic):
         self._logger.debug("Removing subscription record: %s", topic)
diff --git a/AWSIoTPythonSDK/core/protocol/mqtt_core.py b/AWSIoTPythonSDK/core/protocol/mqtt_core.py
@@ -296,7 +296,7 @@ def subscribe(self, topic, qos, message_callback=None):
         self._logger.info("Performing sync subscribe...")
         ret = False
         if ClientStatus.STABLE != self._client_status.get_status():
-            self._handle_offline_request(RequestTypes.SUBSCRIBE, (topic, qos, message_callback))
+            self._handle_offline_request(RequestTypes.SUBSCRIBE, (topic, qos, message_callback, None))
         else:
             event = Event()
             rc, mid = self._subscribe_async(topic, qos, self._create_blocking_ack_callback(event), message_callback)
@@ -317,7 +317,7 @@ def subscribe_async(self, topic, qos, ack_callback=None, message_callback=None):
             return mid
 
     def _subscribe_async(self, topic, qos, ack_callback=None, message_callback=None):
-        self._subscription_manager.add_record(topic, qos, message_callback)
+        self._subscription_manager.add_record(topic, qos, message_callback, ack_callback)
         rc, mid = self._internal_async_client.subscribe(topic, qos, ack_callback)
         if MQTT_ERR_SUCCESS != rc:
             self._logger.error("Subscribe error: %d", rc)
@@ -328,7 +328,7 @@ def unsubscribe(self, topic):
         self._logger.info("Performing sync unsubscribe...")
         ret = False
         if ClientStatus.STABLE != self._client_status.get_status():
-            self._handle_offline_request(RequestTypes.UNSUBSCRIBE, (topic))
+            self._handle_offline_request(RequestTypes.UNSUBSCRIBE, (topic, None))
         else:
             event = Event()
             rc, mid = self._unsubscribe_async(topic, self._create_blocking_ack_callback(event))
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -2,6 +2,10 @@
 CHANGELOG
 =========
 
+1.4.8
+=====
+* improvement: Added support for subscription acknowledgement callbacks while offline or resubscribing
+  
 1.4.7
 =====
 * improvement: Added connection establishment control through client socket factory option
diff --git a/README.rst b/README.rst
@@ -142,7 +142,7 @@ types:
    For the certificate-based mutual authentication connection
    type.
    Download the `AWS IoT root
-   CA <https://www.symantec.com/content/en/us/enterprise/verisign/roots/VeriSign-Class%203-Public-Primary-Certification-Authority-G5.pem>`__.
+   CA <https://docs.aws.amazon.com/iot/latest/developerguide/managing-device-certs.html#server-authentication>`__.
    Use the AWS IoT console to create and download the certificate and private key. You must specify the location of these files 
    when you initialize the client.
 
@@ -151,8 +151,8 @@ types:
    For the Websocket with Signature Version 4 authentication type. You will need IAM credentials: an access key ID, a secret access
    key, and an optional session token. You must  also
    download the `AWS IoT root
-   CA <https://www.symantec.com/content/en/us/enterprise/verisign/roots/VeriSign-Class%203-Public-Primary-Certification-Authority-G5.pem>`__.
-   You can specify the IAM credentails by:
+   CA <https://docs.aws.amazon.com/iot/latest/developerguide/managing-device-certs.html#server-authentication>`__.
+   You can specify the IAM credentials by:
 
    -  Passing method parameters
 

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		`-__version__ = "1.4.7"`
	`1`	`+__version__ = "1.4.8"`
`2`	`2`
`3`	`3`