Skip to content

Commit 46a522b

Browse files
hidmicahcorde
authored andcommitted
Update publisher/subscription matched count API documentation. (#262)
Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
1 parent 6a09145 commit 46a522b

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

rmw/include/rmw/rmw.h

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -450,10 +450,21 @@ rmw_publish_loaned_message(
450450
* Query the underlying middleware to determine how many subscriptions are
451451
* matched to a given publisher.
452452
*
453+
* <hr>
454+
* Attribute | Adherence
455+
* ------------------ | -------------
456+
* Allocates Memory | No
457+
* Thread-Safe | No
458+
* Uses Atomics | Maybe [1]
459+
* Lock-Free | Maybe [1]
460+
* <i>[1] rmw implementation defined, check the implementation documentation</i>
461+
*
453462
* \param[in] publisher the publisher object to inspect
454463
* \param[out] subscription_count the number of subscriptions matched
455464
* \return `RMW_RET_OK` if successful, or
456465
* \return `RMW_RET_INVALID_ARGUMENT` if either argument is null, or
466+
* \return `RMW_RET_INCORRECT_RMW_IMPLEMENTATION` if publisher
467+
* implementation identifier does not match, or
457468
* \return `RMW_RET_ERROR` if an unexpected error occurs.
458469
*/
459470
RMW_PUBLIC
@@ -767,10 +778,21 @@ rmw_destroy_subscription(rmw_node_t * node, rmw_subscription_t * subscription);
767778
* Query the underlying middleware to determine how many publishers are
768779
* matched to a given subscription.
769780
*
781+
* <hr>
782+
* Attribute | Adherence
783+
* ------------------ | -------------
784+
* Allocates Memory | No
785+
* Thread-Safe | No
786+
* Uses Atomics | Maybe [1]
787+
* Lock-Free | Maybe [1]
788+
* <i>[1] rmw implementation defined, check the implementation documentation</i>
789+
*
770790
* \param[in] subscription the subscription object to inspect
771791
* \param[out] publisher_count the number of publishers matched
772792
* \return `RMW_RET_OK` if successful, or
773793
* \return `RMW_RET_INVALID_ARGUMENT` if either argument is null, or
794+
* \return `RMW_RET_INCORRECT_RMW_IMPLEMENTATION` if subscription
795+
* implementation identifier does not match, or
774796
* \return `RMW_RET_ERROR` if an unexpected error occurs.
775797
*/
776798
RMW_PUBLIC

0 commit comments

Comments
 (0)