2021-01-28 00:20:32 +00:00
|
|
|
.. _module-pw_multisink:
|
|
|
|
|
2021-05-17 18:11:56 +00:00
|
|
|
============
|
2021-01-28 00:20:32 +00:00
|
|
|
pw_multisink
|
2021-05-17 18:11:56 +00:00
|
|
|
============
|
2021-01-28 00:20:32 +00:00
|
|
|
This is an module that forwards messages to multiple attached sinks, which
|
|
|
|
consume messages asynchronously. It is not ready for use and is under
|
|
|
|
construction.
|
|
|
|
|
2021-05-17 18:11:56 +00:00
|
|
|
Module Configuration Options
|
|
|
|
============================
|
|
|
|
The following configurations can be adjusted via compile-time configuration
|
|
|
|
of this module, see the
|
|
|
|
:ref:`module documentation <module-structure-compile-time-configuration>` for
|
|
|
|
more details.
|
|
|
|
|
|
|
|
.. c:macro:: PW_MULTISINK_CONFIG_LOCK_INTERRUPT_SAFE
|
|
|
|
|
|
|
|
Whether an interrupt-safe lock is used to guard multisink read/write operations.
|
|
|
|
|
|
|
|
By default, this option is enabled and the multisink uses an interrupt spin-lock
|
|
|
|
to guard its transactions. If disabled, a mutex is used instead.
|
|
|
|
|
|
|
|
Disabling this will alter the entry precondition of the multisink, requiring that
|
|
|
|
it not be called from an interrupt context.
|