rclcpp::detail::PendingLink Struct Reference

#include <future.hpp>

Collaboration diagram for rclcpp::detail::PendingLink:

Public Attributes
uint8_t *	buf = nullptr
	the future's own receive buffer
bool	by_goal = false
size_t	cap = 0
uint8_t	goal_id [16] = {}
size_t	len = 0
PendingList *	list = nullptr
PendingLink *	next = nullptr
bool	orphaned = false
	The client went away while the request was pending: never answerable.
bool	ready = false
int64_t	seq = SEQUENCE_ID_UNKNOWN
void *	storage = nullptr

Member Data Documentation

buf

uint8_t* rclcpp::detail::PendingLink::buf = nullptr

the future's own receive buffer

by_goal

bool rclcpp::detail::PendingLink::by_goal = false

Issue 2011 — an ACTION future is keyed by its GOAL instead of a sequence id: an action client's acceptance and result arrive attributed to a goal (the Rust core correlates each sub-client's replies by id, issue 2009), so the goal is the key a reply carries up here.

cap

size_t rclcpp::detail::PendingLink::cap = 0

goal_id

uint8_t rclcpp::detail::PendingLink::goal_id[16] = {}

len

size_t rclcpp::detail::PendingLink::len = 0

list

PendingList* rclcpp::detail::PendingLink::list = nullptr

The list this future is on while its request is pending; nullptr for an unkeyed future, or once the future is consumed or cancelled.

next

PendingLink* rclcpp::detail::PendingLink::next = nullptr

orphaned

bool rclcpp::detail::PendingLink::orphaned = false

The client went away while the request was pending: never answerable.

ready

bool rclcpp::detail::PendingLink::ready = false

seq

int64_t rclcpp::detail::PendingLink::seq = SEQUENCE_ID_UNKNOWN

storage

void* rclcpp::detail::PendingLink::storage = nullptr

The client storage the future takes from (the poll client's, or the action client's for an unkeyed future).

---

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

• include/rclcpp/future.hpp