Skip to content

Commit

Permalink
Clarify thread safety
Browse files Browse the repository at this point in the history
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
  • Loading branch information
ivanpauno committed Jul 17, 2020
1 parent ce8161d commit 2ded9f7
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion rcl/include/rcl/context.h
Original file line number Diff line number Diff line change
Expand Up @@ -248,10 +248,13 @@ rcl_context_get_instance_id(rcl_context_t * context);
* Attribute | Adherence
* ------------------ | -------------
* Allocates Memory | No
* Thread-Safe | No
* Thread-Safe | Yes [1]
* Uses Atomics | No
* Lock-Free | No
*
* <i>[1] Calling the function asynchronously with `rcl_init` or `rcl_shutdown` can result
* in the function sometimes succeeding and sometimes returning `RCL_RET_INVALID_ARGUMENT`.
*
* \param[in] context object from which the domain id should be retrieved.
* \param[out] domain_id output variable where the domain id will be returned.
* \return RCL_RET_INVALID_ARGUMENT if `context` is invalid, or
Expand Down

0 comments on commit 2ded9f7

Please sign in to comment.