Update gid API documentation. #274
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Namely, rmw_get_gid_for_publisher() and rmw_compare_gids_equal(). Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
This was referenced Sep 21, 2020
Lobotuerk
approved these changes
Sep 22, 2020
clalancette
requested changes
Sep 22, 2020
rmw/include/rmw/rmw.h
Outdated
| @@ -2081,23 +2081,69 @@ rmw_count_subscribers( | |||
| const char * topic_name, | |||
| size_t * count); | |||
|
|
|||
| /// Get the unique identifier of the publisher | |||
| /// Get the unique identifier or gid of a publisher. | |||
There was a problem hiding this comment.
Suggested change
| /// Get the unique identifier or gid of a publisher. | |
| /// Get the unique identifier (gid) of a publisher. |
(is that what is meant here?)
There was a problem hiding this comment.
Yeap, yeap. See 8899558.
rmw/include/rmw/rmw.h
Outdated
| * Publishers are thread-safe objects, and so are all operations on them except for | ||
| * finalization. | ||
| * Therefore, it is safe to get the unique identifier from the same publisher concurrently. | ||
| * However, Access to the gid is not synchronized. |
There was a problem hiding this comment.
Suggested change
| * However, Access to the gid is not synchronized. | |
| * However, access to the gid is not synchronized. |
rmw/include/rmw/rmw.h
Outdated
| * \param[in] publisher Publisher to be get a gid from. | ||
| * \param[out] gid Publisher's unique identifier, populated on success | ||
| * but left unchanged on failure. | ||
| * \return `RMW_RET_OK` if successful, o |
There was a problem hiding this comment.
Suggested change
| * \return `RMW_RET_OK` if successful, o | |
| * \return `RMW_RET_OK` if successful, or |
There was a problem hiding this comment.
Oof, I clearly did this in rush. See 8899558.
rmw/include/rmw/rmw.h
Outdated
| * \param[in] gid1 First unique identifier to compare. | ||
| * \param[in] gid2 Second unique identifier to compare. | ||
| * \param[out] bool true if both gids are equal, false otherwise. | ||
| * \return `RMW_RET_OK` if successful, |
There was a problem hiding this comment.
Suggested change
| * \return `RMW_RET_OK` if successful, | |
| * \return `RMW_RET_OK` if successful, or |
rmw/include/rmw/rmw.h
Outdated
Comment on lines
2144
to
2145
| * \return `RMW_RET_INCORRECT_RMW_IMPLEMENTATION` if `gid1`'s' or `gid2`'s' implementation | ||
| * identifier does the match this implementation, or |
There was a problem hiding this comment.
Suggested change
| * \return `RMW_RET_INCORRECT_RMW_IMPLEMENTATION` if `gid1`'s' or `gid2`'s' implementation | |
| * identifier does the match this implementation, or | |
| * \return `RMW_RET_INCORRECT_RMW_IMPLEMENTATION` if the implementation identifier of | |
| * `gid1` or `gid2` does not match this implementation, or |
rmw/include/rmw/rmw.h
Outdated
| */ | ||
| RMW_PUBLIC | ||
| RMW_WARN_UNUSED | ||
| rmw_ret_t | ||
| rmw_get_gid_for_publisher(const rmw_publisher_t * publisher, rmw_gid_t * gid); | ||
|
|
||
| /// Check if two gid objects are the same | ||
| /// Check if two unique identifiers or gids are equal. |
There was a problem hiding this comment.
Suggested change
| /// Check if two unique identifiers or gids are equal. | |
| /// Check if two unique identifiers (gids) are equal. |
Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
clalancette
approved these changes
Sep 22, 2020
rmw/include/rmw/rmw.h
Outdated
| * | ||
| * \pre Given `publisher` must be a valid subscription, as returned by rmw_create_publisher(). | ||
| * | ||
| * \param[in] publisher Publisher to be get a gid from. |
There was a problem hiding this comment.
Suggested change
| * \param[in] publisher Publisher to be get a gid from. | |
| * \param[in] publisher Publisher to get a gid from. |
Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
ahcorde
pushed a commit
that referenced
this pull request
Oct 13, 2020
Namely, rmw_get_gid_for_publisher() and rmw_compare_gids_equal(). Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
ahcorde
pushed a commit
that referenced
this pull request
Oct 13, 2020
Namely, rmw_get_gid_for_publisher() and rmw_compare_gids_equal(). Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Namely, rmw_get_gid_for_publisher() and rmw_compare_gids_equal().