You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -263,6 +263,10 @@ The following additional configuration options available as environment variable
263
263
-`ZENOH_SHM_ALLOC_SIZE`:size (in bytes) of memory to allocate as shared memory arena. Must be a multiple of4. The default value is 48 MiB.
264
264
-`ZENOH_SHM_MESSAGE_SIZE_THRESHOLD`:threshold (in bytes) forROS message wire size to be sent as SHMbuffer. Must be a multiple of4. The default value is 512. Note that depending on your hardware caracteristics (CPU, memory) it could be counter-productive for the latency of small messages to lower this threashold.
265
265
266
+
> [!IMPORTANT]
267
+
> Make sure that the host's shared memory space (`/dev/shm` on Linux) is large enough for all the processes you run to allocate the `ZENOH_SHM_ALLOC_SIZE` amount of memory. As `rmw_zenoh` is pre-commiting the memory on startup, a process will fail if the shared memory is not available.
268
+
> The default value of 48 MiB has been chosen to support out-of-the-box very large payloads such as a 4K video image (~24 MiB per image, 2 images in-flight). If you want to reduce the global amount of shared memory used by your ROS 2 system, you can tune the `ZENOH_SHM_ALLOC_SIZE` value according to each node requirements.
269
+
266
270
### Interoperability
267
271
268
272
- SHM-enabled nodes are fully interoperable with remote (non-localhost) nodes and localhost non-SHM-enabled nodes on transparent basis.
0 commit comments