diff --git a/rmw/include/rmw/rmw.h b/rmw/include/rmw/rmw.h index 9e6d5c89..8c80e626 100644 --- a/rmw/include/rmw/rmw.h +++ b/rmw/include/rmw/rmw.h @@ -450,10 +450,21 @@ rmw_publish_loaned_message( * Query the underlying middleware to determine how many subscriptions are * matched to a given publisher. * + *
+ * Attribute | Adherence + * ------------------ | ------------- + * Allocates Memory | No + * Thread-Safe | No + * Uses Atomics | Maybe [1] + * Lock-Free | Maybe [1] + * [1] rmw implementation defined, check the implementation documentation + * * \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 @@ -767,10 +778,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. * + *
+ * Attribute | Adherence + * ------------------ | ------------- + * Allocates Memory | No + * Thread-Safe | No + * Uses Atomics | Maybe [1] + * Lock-Free | Maybe [1] + * [1] rmw implementation defined, check the implementation documentation + * * \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