acknowledge messages with IDs the library doesn't know

passing · passing · commit fcf5f2eea4f8 · 2021-05-24T14:36:21.000+02:00
diff --git a/jamulus.py b/jamulus.py
@@ -757,14 +757,18 @@ def main_pack(self, key, values, count):
 
         return data
 
-    def main_unpack(self, data):
+    def main_unpack(self, data, ackn, addr):
         """
         Decode a Jamulus 'main frame'
 
         Parameters
         ----------
         data : bytearray
             encoded data
+        ackn : bool
+            send acknowledgement messages when needed
+        addr : tuple(str, int)
+            host/port for sending the acknoledgement
 
         Returns
         -------
@@ -785,13 +789,18 @@ def main_unpack(self, data):
 
         # unpack main frame
         main_values, offset = self.unpack(FORMAT["MAIN_FRAME"], data)
+        id = main_values["id"]
+        count = main_values["count"]
 
         # verify there's no data left
         if offset != len(data):
             raise ValueError("invalid message length ({}/{}) {}".format(offset, len(data)))
 
+        # send acknowledgement
+        if ackn:
+            self.send_ack(addr, id, count)
+
         # verify ID is valid
-        id = main_values["id"]
         if id not in MSG_KEYS.keys() or id == 0:
             raise ValueError("invalid message ID ({})".format(id))
 
@@ -803,24 +812,23 @@ def main_unpack(self, data):
         # unpack data
         values = self.prot_unpack(format, main_values["data"], repeat=repeat)
 
-        return key, main_values["count"], values
+        return key, count, values
 
-    def send_ack(self, addr, key, count):
+    def send_ack(self, addr, id, count):
         """
         Send an acknowledgement message
 
-        acknowledgement message is only sent if required for the given key
+        acknowledgement message is only sent if required for the given ID
 
         Parameters
         ----------
         addr : tuple(str, int)
             host/port to send to
-        key : str
-            key of message that gets acknowledged
+        id : int
+            ID of message that gets acknowledged
         count : int
-            count of the message that gets acknowledged
+            count of message that gets acknowledged
         """
-        id = MSG_IDS.get(key, 0)
         if id > MSG_IDS["ACKN"] and id < MSG_IDS["CLM_START"]:
             self.sendto(
                 addr=addr,
@@ -856,7 +864,7 @@ def log_message(self, addr, key, count="-", length="", values=None, recv=True):
                 key,
                 length,
             )
-            if self.log_data and key != "ACKN" and values is not None and len(values) > 0:
+            if self.log_data and values is not None and len(values) > 0:
                 output += " {}".format(values)
             print(output)
 
@@ -931,10 +939,8 @@ def recvfrom(self, timeout=None, ackn=True, bufsize=MAX_SIZE_BYTES_NETW_BUF):
         try:
             # detect protocol messages
             if len(data) >= 9 and data[:2] == b"\x00\x00":
-                key, count, values = self.main_unpack(data)
+                key, count, values = self.main_unpack(data, ackn, addr)
                 self.log_message(addr, key, count=count, length=len(data), values=values, recv=True)
-                if ackn:
-                    self.send_ack(addr, key, count)
 
             # assume audio messages
             elif len(data) >= 1:
diff --git a/test_jamulus.py b/test_jamulus.py
@@ -94,12 +94,12 @@ def test_main_pack(self):
         self.assertEqual(data.hex(), "0000e903000400000000006f60")
 
     def test_main_unpack(self):
-        key, count, values = self.jc.main_unpack(bytearray.fromhex("0000ef0300000018cb"))
+        key, count, values = self.jc.main_unpack(bytearray.fromhex("0000ef0300000018cb"), ackn=False, addr=None)
         self.assertEqual(key, "CLM_REQ_SERVER_LIST")
         self.assertEqual(count, 0)
         self.assertEqual(values, {})
 
-        key, count, values = self.jc.main_unpack(bytearray.fromhex("0000e903000400000000006f60"))
+        key, count, values = self.jc.main_unpack(bytearray.fromhex("0000e903000400000000006f60"), ackn=False, addr=None)
         self.assertEqual(key, "CLM_PING_MS")
         self.assertEqual(count, 0)
         self.assertEqual(values, {"time": 0})
