Skip to content

Commit 3ac5f99

Browse files
committed
Fix comments
Signed-off-by: Minju, Lee <dlalswn531@naver.com>
1 parent 6771282 commit 3ac5f99

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

rmw/include/rmw/get_topic_endpoint_info.h

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -191,12 +191,18 @@ rmw_get_subscriptions_info_by_topic(
191191
* This function returns an array of endpoint information for each client
192192
* of a given service, as discovered so far by the given node.
193193
* Endpoint information includes the client's node name and namespace,
194-
* the associated topic type, the client's gid, and the client QoS profile.
195-
* Names of non-existent topics are allowed, in which case an empty array will be returned.
194+
* the associated service type, the client's gid, and the client QoS profile.
195+
* Names of non-existent services are allowed, in which case an empty array will be returned.
196196
*
197197
* Depending on the RMW in use, discovery may be asynchronous. Therefore, creating a client
198198
* and then calling this API may not show the newly created client immediately.
199199
*
200+
* \par Internal behavior
201+
* In ROS middleware (RMW), service endpoints are internally handled as topics.
202+
* Specifically, the client acts as a DataReader and the server as a DataWriter,
203+
* populating the corresponding topic endpoint information. Therefore, all fields of
204+
* `rmw_topic_endpoint_info_t` can be filled in by querying the graph cache.
205+
*
200206
* \par QoS that are correctly read
201207
* Not all QoS may be read correctly, \sa rmw_get_publishers_info_by_topic() for more details.
202208
*
@@ -271,12 +277,18 @@ rmw_get_clients_info_by_service(
271277
* This function returns an array of endpoint information for each server
272278
* of a given service, as discovered so far by the given node.
273279
* Endpoint information includes the server's node name and namespace,
274-
* the associated topic type, the server's gid, and the server QoS profile.
275-
* Names of non-existent topics are allowed, in which case an empty array will be returned.
280+
* the associated service type, the server's gid, and the server QoS profile.
281+
* Names of non-existent services are allowed, in which case an empty array will be returned.
276282
*
277283
* Depending on the RMW in use, discovery may be asynchronous. Therefore, creating a server
278284
* and then calling this API may not show the newly created server immediately.
279285
*
286+
* \par Internal behavior
287+
* In ROS middleware (RMW), service endpoints are internally handled as topics.
288+
* Specifically, the client acts as a DataReader and the server as a DataWriter,
289+
* populating the corresponding topic endpoint information. Therefore, all fields of
290+
* `rmw_topic_endpoint_info_t` can be filled in by querying the graph cache.
291+
*
280292
* \par QoS that are correctly read
281293
* Not all QoS may be read correctly, \sa rmw_get_publishers_info_by_topic() for more details.
282294
*

0 commit comments

Comments
 (0)