Skip to content

Commit

Permalink
doc: zbus: isolated pool by channel
Browse files Browse the repository at this point in the history
Add the information about the possibility of isolating the pool per
channel.

Signed-off-by: Rodrigo Peixoto <[email protected]>
  • Loading branch information
rodrigopex authored and nashif committed Jun 18, 2024
1 parent 6ec6173 commit d0a2451
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions doc/services/zbus/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -398,10 +398,13 @@ rate by following design tips:

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

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



.. _zbus delivery sequence:

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

0 comments on commit d0a2451

Please sign in to comment.