Skip to content

Commit f238674

Browse files
authored
Doc destroy_node may assume correct destruction order (#216)
Signed-off-by: Shane Loretz <[email protected]>
1 parent 974ef92 commit f238674

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

rmw/include/rmw/rmw.h

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,12 @@ rmw_create_node(
177177

178178
/// Finalize a given node handle, reclaim the resources, and deallocate the node handle.
179179
/**
180+
* The method may assume - but should verify - that all publishers, subscribers,
181+
* services, and clients created from this node have already been destroyed.
182+
* If the rmw implementation chooses to verify instead of assume, it should
183+
* return `RMW_RET_ERROR` and set a human readable error message if any entity
184+
* created from this node has not yet been destroyed.
185+
*
180186
* \param node the node handle to be destroyed
181187
* \return `RMW_RET_OK` if successful, or
182188
* \return `RMW_RET_INVALID_ARGUMENT` if node is null, or

0 commit comments

Comments
 (0)