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

Update publisher/subscription matched count API documentation. #262

Merged
merged 2 commits into from
Aug 27, 2020
Merged

Update publisher/subscription matched count API documentation. #262

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
00c7d19
Update publisher/subscription matched count API documentation.
hidmic Aug 20, 2020
1083ea1
Drop copy-paste leftover.
hidmic Aug 20, 2020
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
22 changes: 22 additions & 0 deletions rmw/include/rmw/rmw.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -448,10 +448,21 @@ rmw_publish_loaned_message(
* Query the underlying middleware to determine how many subscriptions are
* matched to a given publisher.
*
* <hr>
* Attribute | Adherence
* ------------------ | -------------
* Allocates Memory | No
* Thread-Safe | No
* Uses Atomics | Maybe [1]
* Lock-Free | Maybe [1]
* <i>[1] rmw implementation defined, check the implementation documentation</i>
*
* \param[in] publisher the publisher object to inspect
* \param[out] subscription_count the number of subscriptions matched
* \return `RMW_RET_OK` if successful, or
* \return `RMW_RET_INVALID_ARGUMENT` if either argument is null, or
* \return `RMW_RET_INCORRECT_RMW_IMPLEMENTATION` if publisher
* implementation identifier does not match, or
* \return `RMW_RET_ERROR` if an unexpected error occurs.
*/
RMW_PUBLIC
Expand Down Expand Up @@ -753,10 +764,21 @@ rmw_destroy_subscription(rmw_node_t * node, rmw_subscription_t * subscription);
* Query the underlying middleware to determine how many publishers are
* matched to a given subscription.
*
* <hr>
* Attribute | Adherence
* ------------------ | -------------
* Allocates Memory | No
* Thread-Safe | No
* Uses Atomics | Maybe [1]
* Lock-Free | Maybe [1]
* <i>[1] rmw implementation defined, check the implementation documentation</i>
*
* \param[in] subscription the subscription object to inspect
* \param[out] publisher_count the number of publishers matched
* \return `RMW_RET_OK` if successful, or
* \return `RMW_RET_INVALID_ARGUMENT` if either argument is null, or
* \return `RMW_RET_INCORRECT_RMW_IMPLEMENTATION` if subscription
* implementation identifier does not match, or
* \return `RMW_RET_ERROR` if an unexpected error occurs.
*/
RMW_PUBLIC
Expand Down