rcl_action_client_t Struct Reference

#include <nros_generated.h>

Collaboration diagram for rcl_action_client_t:

Data Fields
struct ActionClientInternal	_internal
uint8_t	action_name [256]
size_t	action_name_len
rclc_cancel_response_callback_t	cancel_response_callback
void *	context
struct rclc_action_endpoint_hashes_t	endpoint_hashes
rclc_feedback_callback_t	feedback_callback
rclc_goal_response_callback_t	goal_response_callback
struct rclc_node_ref_t	node
struct rcl_action_client_options_t	options
rclc_result_callback_t	result_callback
enum rclc_action_client_state_t	state
uint8_t	type_hash [128]
size_t	type_hash_len
uint8_t	type_name [256]
size_t	type_name_len

Detailed Description

An action client the executor dispatches.

phase-487 W4 (RFC-0096 D9, the C half): the executor arena owns the channels and buffers; this struct holds the arena handle (_internal), the registration description and the callback record the arena's trampolines read, as the C++ action client does. A client the caller drives itself is a [rclc_polling_action_client_t].

Field Documentation

_internal

struct ActionClientInternal rcl_action_client_t::_internal

Internal state (arena entry index + executor pointer). Phase 87.5: Typed C-ABI handle field.

action_name

uint8_t rcl_action_client_t::action_name[256]

Action name storage

action_name_len

size_t rcl_action_client_t::action_name_len

Action name length

cancel_response_callback

rclc_cancel_response_callback_t rcl_action_client_t::cancel_response_callback

Issue 2030 — cancel-response callback (optional; see [rclc_action_client_set_cancel_response_callback]).

context

void* rcl_action_client_t::context

User context pointer

endpoint_hashes

struct rclc_action_endpoint_hashes_t rcl_action_client_t::endpoint_hashes

Issue 1913 — the per-endpoint hashes, copied from the type support at init (static-storage pointers; NULL falls back to type_hash).

feedback_callback

rclc_feedback_callback_t rcl_action_client_t::feedback_callback

Feedback callback

goal_response_callback

rclc_goal_response_callback_t rcl_action_client_t::goal_response_callback

Goal response callback (for async send_goal)

node

struct rclc_node_ref_t rcl_action_client_t::node

Pointer to parent node

options

struct rcl_action_client_options_t rcl_action_client_t::options

Phase 189.M3.3.b — scheduling-context slot to bind the action client's executor handle to. 0 = inherit the executor / Node default; set via rcl_action_client_init's options. When non-zero, rclc_executor_attach_action_client binds the handle after registration. No effect on the L1 polling path.

result_callback

rclc_result_callback_t rcl_action_client_t::result_callback

Result callback

state

enum rclc_action_client_state_t rcl_action_client_t::state

Current state

type_hash

uint8_t rcl_action_client_t::type_hash[128]

Type hash storage

type_hash_len

size_t rcl_action_client_t::type_hash_len

Type hash length

type_name

uint8_t rcl_action_client_t::type_name[256]

Type name storage

type_name_len

size_t rcl_action_client_t::type_name_len

Type name length

---

The documentation for this struct was generated from the following file:

• include/rclc/detail/nros_generated.h