Skip to content

Commit d0a2451

Browse files
rodrigopexnashif
authored andcommitted
doc: zbus: isolated pool by channel
Add the information about the possibility of isolating the pool per channel. Signed-off-by: Rodrigo Peixoto <[email protected]>
1 parent 6ec6173 commit d0a2451

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

doc/services/zbus/index.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -398,10 +398,13 @@ rate by following design tips:
398398

399399
.. warning::
400400
ZBus uses :zephyr_file:`include/zephyr/net/buf.h` (network buffers) to exchange data with message
401-
subscribers. So, chose carefully the configurations
401+
subscribers. Thus, choose carefully the configurations
402402
:kconfig:option:`CONFIG_ZBUS_MSG_SUBSCRIBER_NET_BUF_POOL_SIZE` and
403403
:kconfig:option:`CONFIG_HEAP_MEM_POOL_SIZE`. They are crucial to a proper VDED execution
404-
(delivery guarantee) considering message subscribers.
404+
(delivery guarantee) considering message subscribers. If you want to keep an isolated pool for a
405+
specific set of channels, you can use
406+
:kconfig:option:`CONFIG_ZBUS_MSG_SUBSCRIBER_NET_BUF_POOL_ISOLATION` with a dedicated pool. Look
407+
at the :zephyr:code-sample:`zbus-msg-subscriber` to see the isolation in action.
405408

406409
.. warning::
407410
Subscribers will receive only the reference of the changing channel. A data loss may be perceived
@@ -410,7 +413,6 @@ rate by following design tips:
410413
only the last data is there.
411414

412415

413-
414416
.. _zbus delivery sequence:
415417

416418
Message delivery sequence
@@ -898,6 +900,8 @@ Related configuration options:
898900
buffers;
899901
* :kconfig:option:`CONFIG_ZBUS_MSG_SUBSCRIBER_NET_BUF_POOL_SIZE` the available number of message
900902
buffers to be used simultaneously;
903+
* :kconfig:option:`CONFIG_ZBUS_MSG_SUBSCRIBER_NET_BUF_POOL_ISOLATION` enables the developer to isolate
904+
a pool for the message subscriber for a set of channels;
901905
* :kconfig:option:`CONFIG_ZBUS_MSG_SUBSCRIBER_NET_BUF_STATIC_DATA_SIZE` the biggest message of zbus
902906
channels to be transported into a message buffer;
903907
* :kconfig:option:`CONFIG_ZBUS_RUNTIME_OBSERVERS` enables the runtime observer registration.

0 commit comments

Comments
 (0)