Skip to content

Commit

Permalink
Fix comments
Browse files Browse the repository at this point in the history
Signed-off-by: Minju, Lee <[email protected]>
  • Loading branch information
leeminju531 committed Sep 27, 2024
1 parent 6771282 commit 3ac5f99
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions rmw/include/rmw/get_topic_endpoint_info.h
Original file line number Diff line number Diff line change
Expand Up @@ -191,12 +191,18 @@ rmw_get_subscriptions_info_by_topic(
* This function returns an array of endpoint information for each client
* of a given service, as discovered so far by the given node.
* Endpoint information includes the client's node name and namespace,
* the associated topic type, the client's gid, and the client QoS profile.
* Names of non-existent topics are allowed, in which case an empty array will be returned.
* the associated service type, the client's gid, and the client QoS profile.
* Names of non-existent services are allowed, in which case an empty array will be returned.
*
* Depending on the RMW in use, discovery may be asynchronous. Therefore, creating a client
* and then calling this API may not show the newly created client immediately.
*
* \par Internal behavior
* In ROS middleware (RMW), service endpoints are internally handled as topics.
* Specifically, the client acts as a DataReader and the server as a DataWriter,
* populating the corresponding topic endpoint information. Therefore, all fields of
* `rmw_topic_endpoint_info_t` can be filled in by querying the graph cache.
*
* \par QoS that are correctly read
* Not all QoS may be read correctly, \sa rmw_get_publishers_info_by_topic() for more details.
*
Expand Down Expand Up @@ -271,12 +277,18 @@ rmw_get_clients_info_by_service(
* This function returns an array of endpoint information for each server
* of a given service, as discovered so far by the given node.
* Endpoint information includes the server's node name and namespace,
* the associated topic type, the server's gid, and the server QoS profile.
* Names of non-existent topics are allowed, in which case an empty array will be returned.
* the associated service type, the server's gid, and the server QoS profile.
* Names of non-existent services are allowed, in which case an empty array will be returned.
*
* Depending on the RMW in use, discovery may be asynchronous. Therefore, creating a server
* and then calling this API may not show the newly created server immediately.
*
* \par Internal behavior
* In ROS middleware (RMW), service endpoints are internally handled as topics.
* Specifically, the client acts as a DataReader and the server as a DataWriter,
* populating the corresponding topic endpoint information. Therefore, all fields of
* `rmw_topic_endpoint_info_t` can be filled in by querying the graph cache.
*
* \par QoS that are correctly read
* Not all QoS may be read correctly, \sa rmw_get_publishers_info_by_topic() for more details.
*
Expand Down

0 comments on commit 3ac5f99

Please sign in to comment.