Function rmw_destroy_wait_set

Function Documentation

rmw_ret_t rmw_destroy_wait_set(rmw_wait_set_t *wait_set)

Destroy a wait set.

This function will reclaim all associated resources, including the wait set. Use of a wait set after destruction is undefined behavior. This function will return early if a logical error, such as RMW_RET_INVALID_ARGUMENT or RMW_RET_INCORRECT_RMW_IMPLEMENTATION, ensues, leaving the given wait set unchanged. Otherwise, it will proceed despite errors.

Attribute

Adherence

Allocates Memory

No

Thread-Safe

No

Uses Atomics

Maybe [1]

Lock-Free

Maybe [1]

[1] rmw implementation defined, check the implementation documentation

Parameters:

wait_set – [in] Wait set to be finalized.

Pre:

Given wait_set must be a valid wait set, as returned by rmw_create_wait_set().

Returns:

RMW_RET_OK if successful, or

Returns:

RMW_RET_INVALID_ARGUMENT if wait_set is NULL, or

Returns:

RMW_RET_INCORRECT_RMW_IMPLEMENTATION if the wait_set implementation identifier does not match this implementation, or

Returns:

RMW_RET_ERROR if an unspecified error occurs.