You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+47-47Lines changed: 47 additions & 47 deletions
Original file line number
Diff line number
Diff line change
@@ -349,7 +349,7 @@ the internal ones that are automatically created for RMW management (`ros_discov
349
349
and those created by `rcl`for each Node (e.g. `rt/rosout`, `rt/parameter_events`,
350
350
and other topics used to manage node parameters). In order to make sure that these
351
351
endpoints will continue to communicate with applications using the default QoS, you
352
-
may use QoS profile `ros2::rcl.builtin_endpoints` from [ros2_qos_profiles.xml](rmw_connextdds/resource/xml/ros2_qos_profiles.xml)
352
+
may use QoS profile `ROS2QoS::rcl.builtin_endpoints` from [ros2_qos_profiles.xml](rmw_connextdds/resource/xml/ros2_qos_profiles.xml)
353
353
to configure all of these "built-in endpoints" with the correct QoS settings.
354
354
355
355
`RMW_CONNEXT_ENDPOINT_QOS_OVERRIDE_POLICY` may also be set to `dds_topics: <regex>`, e.g.:
@@ -519,7 +519,7 @@ optimizations controlled by [RMW_CONNEXT_DISABLE_FAST_ENDPOINT_DISCOVERY](#RMW_C
519
519
520
520
When using these values, you may replicate the default QoS configuration using
521
521
the profiles defined by XML file [ros2_qos_profiles.xml](rmw_connextdds/resource/xml/ros2_qos_profiles.xml)
522
-
(e.g. `ros2::rmw_connextdds.base_application`). See [DDS Quality of Service Configuration](#dds-quality-of-service-configuration)
522
+
(e.g. `ROS2QoS::rmw_connextdds.base_application`). See [DDS Quality of Service Configuration](#dds-quality-of-service-configuration)
523
523
for more information on these built-in profiles.
524
524
525
525
### RMW_CONNEXT_REQUEST_REPLY_MAPPING
@@ -906,7 +906,7 @@ selected with variable [`RMW_CONNEXT_PARTICIPANT_QOS_OVERRIDE_POLICY`](#rmw_conn
906
906
907
907
The customization may also be replicated in XML by using the QoS profiles contained
908
908
in [ros2_qos_profiles.xml](rmw_connextdds/resource/xml/ros2_qos_profiles.xml),
909
-
for example, `ros2::rmw_connextdds.base_participant`. See [Built-in ROS 2 QoS Profiles](#built-in-ros-2-qos-profiles) for more information about these QoS profiles
909
+
for example, `ROS2QoS::rmw_connextdds.base_participant`. See [Built-in ROS 2 QoS Profiles](#built-in-ros-2-qos-profiles) for more information about these QoS profiles
910
910
and how to use them.
911
911
912
912
### DataWriter and DataReader QoS
@@ -977,7 +977,7 @@ ros2 run demo_nodes_cpp talker
977
977
978
978
A similar result can also be achieved using the `never` "QoS override" policy,
979
979
but the XML QoS profile would require some modifications, for example by making it
980
-
extend profile `ros2::rmw_connextdds.base_application`. Otherwise, the application
980
+
extend profile `ROS2QoS::rmw_connextdds.base_application`. Otherwise, the application
981
981
would not be able to communicatedd with other applications using the default
982
982
ROS 2 QoS profiles over the "built-in" endpoints created by the RMW and `rcl`
983
983
layers.
@@ -1039,32 +1039,32 @@ Connext installation by copying the file (or its contents) to
1039
1039
`ros2_qos_profiles.xml` contains a single QoS library named `ros2`, and containing
Most users should consider using profile [`ROS2QoS::rmw_connextdds.base_application`](#ros2rmw_connextddsbase_application) as the base profile to begin
1055
1055
customization of the DDS QoS used by their applications.
1056
1056
1057
1057
This profile will provide the same QoS settings used by default by `rmw_connextdds`
1058
1058
(i.e. when no custom [runtime configuration](#rmw-runtime-configuration) is specified).
and [`ros2::rmw_connextdds.base_participant`](#ros2rmw_connextddsbase_participant),
1062
-
which are both already included in the inheritance chain of [`ros2::rmw_connextdds.base_application`](#ros2rmw_connextddsbase_application), may be used directly
and [`ROS2QoS::rmw_connextdds.base_participant`](#ros2rmw_connextddsbase_participant),
1062
+
which are both already included in the inheritance chain of [`ROS2QoS::rmw_connextdds.base_application`](#ros2rmw_connextddsbase_application), may be used directly
1063
1063
to, respectively, configure the QoS of all "built-in" endpoints created by the
1064
1064
RMW and `rcl` layers, and to configure the QoS of the DomainParticipant created
1065
1065
by `rmw_connextdds`.
1066
1066
1067
-
QoS profiles in the `ros2::rmw_connextdds.opt.*` namespace describe various
1067
+
QoS profiles in the `ROS2QoS::rmw_connextdds.*` namespace describe various
1068
1068
configurations that are applied optionally by `rmw_connextdds`.
1069
1069
1070
1070
These profiles include:
@@ -1077,58 +1077,58 @@ These profiles include:
1077
1077
- configurations that can be disabled via environment variables (e.g.
1078
1078
"fast endpoints discovery").
1079
1079
1080
-
Other QoS profiles, like the ones in the `ros2::rmw.*` `ros2::rmw.*` namespaces,
1080
+
Other QoS profiles, like the ones in the `ROS2QoS::rmw.*` `ROS2QoS::rmw.*` namespaces,
1081
1081
should only be used as reference.
1082
1082
1083
-
#### ros2::rmw.ros_discovery_info
1083
+
#### ROS2QoS::rmw.ros_discovery_info
1084
1084
1085
-
Profile `ros2::rmw.ros_discovery_info` can be used to customize the QoS for
1085
+
Profile `ROS2QoS::rmw.ros_discovery_info` can be used to customize the QoS for
1086
1086
endpoints on the internal RMW topic `"ros_discovery_info"`.
1087
1087
1088
1088
For the equivalent RMW code, see `rmw_connextdds_graph_initialize()`
1089
1089
in [rmw_graph.cpp](rmw_connextdds_common/src/common/rmw_graph.cpp).
1090
1090
1091
-
#### ros2::rcl.node_parameters
1091
+
#### ROS2QoS::rcl.node_parameters
1092
1092
1093
-
Profile `ros2::rcl.node_parameters` defines the QoS used by endpoints on
1093
+
Profile `ROS2QoS::rcl.node_parameters` defines the QoS used by endpoints on
1094
1094
various topics used for management of node parameters.
1095
1095
1096
1096
See `rmw_qos_profile_parameters` from [rmw/include/rmw/qos_profiles.h](https://github.com/ros2/rmw/blob/master/rmw/include/rmw/qos_profiles.h)
1097
1097
for the equivalent code implementation.
1098
1098
1099
-
#### ros2::rcl.log
1099
+
#### ROS2QoS::rcl.log
1100
1100
1101
-
Profile `ros2::rcl.log` defines the QoS used by endpoints on the ROS logging topic
1101
+
Profile `ROS2QoS::rcl.log` defines the QoS used by endpoints on the ROS logging topic
1102
1102
`"rosout"`.
1103
1103
1104
1104
See `rcl_qos_profile_rosout_default` from [rcl/include/rcl/logging_rosout.h](https://github.com/ros2/rcl/blob/master/rcl/include/rcl/logging_rosout.h)
1105
1105
for the equivalent code implementation.
1106
1106
1107
-
#### ros2::rcl.builtin_endpoints
1107
+
#### ROS2QoS::rcl.builtin_endpoints
1108
1108
1109
1109
Profile `rcl.builtin_endpoints` provides QoS settings for all "built-in"
1110
1110
endpoints created by the RMW and `rcl` layers for every ROS 2 Node.
1111
1111
1112
1112
These "built-in" endpoints include:
1113
1113
1114
-
- Endpoints on topic `"ros_discovery_info"` (configured using profile [`ros2::rmw.ros_discovery_info`](#ros2rmwros_discovery_info)).
1115
-
- Endpoints on topics used for node parameters (configured using profile [`ros2::rcl.node_parameters`](#ros2rclnode_parameters)).
1116
-
- Endpoints on the ROS logging topic `"rosout"` (configured using profile [`ros2::rcl.log`](#ros2rcllog)).
1114
+
- Endpoints on topic `"ros_discovery_info"` (configured using profile [`ROS2QoS::rmw.ros_discovery_info`](#ros2rmwros_discovery_info)).
1115
+
- Endpoints on topics used for node parameters (configured using profile [`ROS2QoS::rcl.node_parameters`](#ros2rclnode_parameters)).
1116
+
- Endpoints on the ROS logging topic `"rosout"` (configured using profile [`ROS2QoS::rcl.log`](#ros2rcllog)).
1117
1117
1118
1118
The parent profiles are applied using "topic filters" that select all required topics.
1119
1119
1120
-
#### ros2::rmw_connextdds.base_participant
1120
+
#### ROS2QoS::rmw_connextdds.base_participant
1121
1121
1122
-
Profile `ros2::rmw_connextdds.base_participant` models the DomainParticipan QoS
1122
+
Profile `ROS2QoS::rmw_connextdds.base_participant` models the DomainParticipan QoS
1123
1123
settings used by `rmw_connextdds` to change some of Connext's "out of the box"
1124
1124
QoS, and make it more amenable to use with ROS 2 applications.
1125
1125
1126
1126
These settings are only applied by `rmw_connextdds` when [`RMW_CONNEXT_PARTICIPANT_QOS_OVERRIDE_POLICY`](#rmw_connext_participant_qos_override_policy)
1127
1127
is either not set, or set to `all`.
1128
1128
1129
-
#### ros2::rmw_connextdds.base_application
1129
+
#### ROS2QoS::rmw_connextdds.base_application
1130
1130
1131
-
Use profile `ros2::rmw_connextdds.base_application` as the base profile when
1131
+
Use profile `ROS2QoS::rmw_connextdds.base_application` as the base profile when
is set to `never` and/or [`RMW_CONNEXT_PARTICIPANT_QOS_OVERRIDE_POLICY`](#rmw_connext_participant_qos_override_policy) is set to a value other than `all`.
1134
1134
@@ -1142,12 +1142,12 @@ to the user to configure this policy as needed in their own profiles.
1142
1142
The asynchronous publish mode is still used for all "built-in" writers to allow them
1143
1143
to continue to operate like "out of the box", even when writing large messages.
1144
1144
1145
-
You might also consider inheriting directly from profile [`ros2::rcl.builtin_endpoints`](#ros2rclbuiltin_endpoints),
1145
+
You might also consider inheriting directly from profile [`ROS2QoS::rcl.builtin_endpoints`](#ros2rclbuiltin_endpoints),
1146
1146
if you only want to configure the built-in endpoints but not the DomainParticipant QoS.
1147
1147
1148
-
#### ros2::rmw_connextdds.opt.large_data
1148
+
#### ROS2QoS::rmw_connextdds.large_data
1149
1149
1150
-
Profile `ros2::rmw_connextdds.opt.large_data` describes the "large data" optimizations
1150
+
Profile `ROS2QoS::rmw_connextdds.large_data` describes the "large data" optimizations
1151
1151
that `rmw_connextdds` applies to endpoints whose type is detected to have a static
1152
1152
maximum serialized size of at least 1MB.
1153
1153
@@ -1156,9 +1156,9 @@ The configuration is derived from Connext's built-in profile `Generic.KeepLastRe
1156
1156
These optimizations are always applied by `rmw_connextdds` to all "qualified" endpoints,
1157
1157
unless variable [`RMW_CONNEXT_DISABLE_LARGE_DATA_OPTIMIZATIONS`](#rmw_connext_disable_large_data_optimizations) is used to disabled them.
1158
1158
1159
-
#### ros2::rmw_connextdds.opt.unbounded_data
1159
+
#### ROS2QoS::rmw_connextdds.unbounded_data
1160
1160
1161
-
The settings from profile `ros2::rmw_connextdds.opt.unbounded_data` are used by
1161
+
The settings from profile `ROS2QoS::rmw_connextdds.unbounded_data` are used by
1162
1162
`rmw_connextdds` to disable preallocation of samples for endpoints whose
1163
1163
data type is "unbounded". This includes any data type containing a string or a
1164
1164
sequence with an unlimited maximum length.
@@ -1170,21 +1170,21 @@ automatically assert them upon endpoint creation.
1170
1170
The profile is provide only documentation purposes, since there is no way to
Profile `ros2::rmw_connextdds.opt.content_filtered_topic_property` is applied by
1175
+
Profile `ROS2QoS::rmw_connextdds.content_filtered_topic_property` is applied by
1176
1176
`rmw_connextdds` when policy [`DomainParticipantQos::resource_limits::contentfilter_property_max_length`](https://community.rti.com/static/documentation/connext-dds/6.0.1/doc/api/connext_dds/api_c/structDDS__DomainParticipantResourceLimitsQosPolicy.html#aef1ff851202f5777d31528a52d528e4f)
1177
1177
is detected to be less than `1024`.
1178
1178
1179
-
#### ros2::rmw_connextdds.opt.localhost_only
1179
+
#### ROS2QoS::rmw_connextdds.localhost_only
1180
1180
1181
-
Profile `ros2::rmw_connextdds.opt.localhost_only` describes the configuration
1181
+
Profile `ROS2QoS::rmw_connextdds.localhost_only` describes the configuration
1182
1182
applied by `rmw_connextdds` to the DomainParticipant QoS when "localhost only"
0 commit comments