Add method for outgoing message count

Author: Shubham

objectbox/c.py

@@ -1228,3 +1228,7 @@ def c_array_pointer(py_list: Union[List[Any], np.ndarray], c_type):
                                            [OBX_sync_p, c_char_p])
 obx_sync_filter_variables_remove_all = c_fn_rc('obx_sync_filter_variables_remove_all',
                                                [OBX_sync_p])
+
+# OBX_C_API obx_err obx_sync_outgoing_message_count(OBX_sync* sync, uint64_t limit, uint64_t* out_count);
+obx_sync_outgoing_message_count = c_fn_rc('obx_sync_outgoing_message_count',
+                                          [OBX_sync_p, ctypes.c_uint64, ctypes.POINTER(ctypes.c_uint64)])

objectbox/sync.py

@@ -273,3 +273,8 @@ def remove_filter_variable(self, name: str):
 
     def remove_all_filter_variables(self):
         c.obx_sync_filter_variables_remove_all(self.__c_sync_client_ptr)
+
+    def get_outgoing_message_count(self, limit: int = 0) -> int:
+        outgoing_message_count = ctypes.c_uint64(0)
+        c.obx_sync_outgoing_message_count(self.__c_sync_client_ptr, limit, ctypes.byref(outgoing_message_count))
+        return outgoing_message_count.value

tests/test_sync.py

@@ -55,3 +55,21 @@ def test_filter_variables(test_store):
 
     with pytest.raises(IllegalArgumentError, match="Filter variables must have a name"):
         client.add_filter_variable("", "val5")
+
+    client.close()
+
+
+def test_outgoing_message_count(test_store):
+    server_urls = ["ws://localhost:9999"]
+    client = SyncClient(test_store, server_urls)
+
+    count = client.get_outgoing_message_count()
+    assert count == 0
+
+    count_limited = client.get_outgoing_message_count(limit=10)
+    assert count_limited == 0
+
+    client.close()
+
+    with pytest.raises(IllegalArgumentError, match='Argument "sync" must not be null'):
+        client.get_outgoing_message_count()