Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a note about asynchronicity of discovery. #352

Merged
merged 1 commit into from
Apr 3, 2023
Merged

Add a note about asynchronicity of discovery. #352

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions rmw/include/rmw/get_topic_endpoint_info.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ extern "C"
* the associated topic type, the publisher's gid, and the publisher QoS profile.
* Names of non-existent topics are allowed, in which case an empty array will be returned.
*
* Depending on the RMW in use, discovery may be asynchronous. Therefore, creating a publisher
* and then calling this API may not show the newly created publisher immediately.
*
* \par QoS that are correctly read
* The QoS profiles returned might have some invalid fields.
* The rmw implementation must set the invalid fields to `RMW_QOS_POLICY_*_UNKNOWN`.
Expand Down Expand Up @@ -113,6 +116,9 @@ rmw_get_publishers_info_by_topic(
* the associated topic type, the subscription's gid, and the subscription QoS profile.
* Names of non-existent topics are allowed, in which case an empty array will be returned.
*
* Depending on the RMW in use, discovery may be asynchronous. Therefore, creating a subscription
* and then calling this API may not show the newly created subscription immediately.
*
* \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