Skip to content

Commit 06de4e8

Browse files
Mention rmw_specific_{pub,sub}_payload in rmw impl tutorial (#5967)
Signed-off-by: Christophe Bedard <[email protected]>
1 parent 0f5db7f commit 06de4e8

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

source/Tutorials/Advanced/Creating-An-RMW-Implementation.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -455,8 +455,11 @@ These tests can use ``rmw``'s ``rmw_get_implementation_identifier()`` `function
455455
Middleware- and ``rmw`` implementation-specific configuration
456456
-------------------------------------------------------------
457457

458-
The ``rmw`` interface as defined by that package does not support passing arbitrary configuration data to the implementation or the underlying middleware.
459-
To get around that and introduce some flexibility, some implementations use environment variables: ``RMW_FASTRTPS_*``, ``RMW_CONNEXT_*``, etc.
458+
The ``rmw`` interface allows providing arbitrary implementation-specific configuration payloads for publishers and subscriptions through the type-erased ``rmw_specific_publisher_payload`` / ``rmw_specific_subscription_payload`` fields in ``rmw_publisher_options_t`` / ``rmw_subscription_options_t``.
459+
This is set by users through ``RMWImplementationSpecificPublisherPayload`` / ``RMWImplementationSpecificSubscriptionPayload`` in ``rclcpp``, for example.
460+
This is an advanced, non-portable feature that is not currently used by any (tier 1) implementations.
461+
462+
For a bit more flexibility, some implementations use environment variables: ``RMW_FASTRTPS_*``, ``RMW_CONNEXT_*``, etc.
460463
The underlying middleware may also be configurable through environment variables: ``FASTDDS_*``, ``ZENOH_*``, ``CYCLONEDDS_*``, ``EMAIL_*``, etc.
461464
For example, the ``CYCLONEDDS_URI``, ``FASTDDS_DEFAULT_PROFILES_FILE``, and ``ZENOH_SESSION_CONFIG_URI`` environment variables can be used to provide a path to a full configuration file if the relevant middleware is used.
462465

0 commit comments

Comments
 (0)