Clarify batch size requirement when operating on multicast (#1428)

* Clarify batch size requirement when operating on multicast * Update DEFAULT_CONFIG.json5 Co-authored-by: Mahmoud Mazouz <[email protected]> --------- Co-authored-by: Mahmoud Mazouz <[email protected]>
eclipse-zenoh · Sep 17, 2024 · dfb3a40 · dfb3a40
1 parent 41e447e
commit dfb3a40
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/DEFAULT_CONFIG.json5 b/DEFAULT_CONFIG.json5
@@ -314,6 +314,13 @@
       },
     },
     multicast: {
+      /// WARNING: multicast communication does not perform any negotiation upon group joining.
+      ///   Because of that, it is important that all transport parameters are the same to make
+      ///   sure all your nodes in the system can communicate. One common parameter to configure
+      ///   is "transport/link/tx/batch_size" since its default value depends on the actual platform
+      ///   when operating on multicast. 
+      ///   E.g., the batch size on Linux and Windows is 65535 bytes, on Mac OS X is 9216, and anything else is 8192.
+
       /// Enables QoS on multicast communication.
       /// Default to false for Zenoh-to-Zenoh-Pico out-of-the-box compatibility.
       qos: {