OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity

doc: zbus: isolated pool by channel 

Add the information about the possibility of isolating the pool per
channel.

Signed-off-by: Rodrigo Peixoto <rodrigopex@gmail.com>
This commit is contained in:
Rodrigo Peixoto 2024-06-08 14:24:13 -03:00 committed by Anas Nashif
parent 6ec617340f
commit d0a2451b6d
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/services/zbus/index.rst
View File

@ -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
@ -410,7 +413,6 @@ rate by following design tips:
only the last data is there.
.. _zbus delivery sequence:
Message delivery sequence
@ -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.