Function rcl_action_send_cancel_response
Defined in File action_server.h
Function Documentation
-
rcl_ret_t rcl_action_send_cancel_response(const rcl_action_server_t *action_server, rmw_request_id_t *response_header, void *ros_cancel_response)
Send a cancel response using an action server.
This is a non-blocking call.
Attribute
Adherence
Allocates Memory
No
Thread-Safe
No
Uses Atomics
No
Lock-Free
Yes
- Parameters:
action_server – [in] handle to the action server that will send the cancel response
response_header – [in] pointer to the cancel response header
ros_cancel_response – [in] a ROS cancel response to send
- Returns:
RCL_RET_OK
if the request was taken, or- Returns:
RCL_RET_INVALID_ARGUMENT
if any arguments are invalid, or- Returns:
RCL_RET_ACTION_SERVER_INVALID
if the action server is invalid, or- Returns:
RCL_RET_TIMEOUT
if a cancel response reader is not ready yet, or- Returns:
RCL_RET_ERROR
if an unspecified error occurs.