client.h

Go to the documentation of this file.

 
#ifndef NROS_CLIENT_H
#define NROS_CLIENT_H
 
/* Type and function definitions live in <nros/nros_generated.h>.
 * This per-module header is kept as a thin shim so existing code that
 * does `#include <nros/client.h>` continues to compile. */
#include "nros/types.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ===================================================================
 * DEPRECATED spellings — phase-379 W6 decision 1 (2026-09-03)
 *
 * `try_recv` -> `take` and `reply` -> `response`, the pair rcl / rclcpp /
 * rclrs use (`rcl_take_response`, `rclcpp::Client::take_response`) and the
 * pair our own RMW vtable already used one layer down. See
 * `nros/subscription.h` for the full note on the shape and the ABI cost
 * (none: these are `static inline`, so `nros_client_take_response*` stay
 * the only exported symbols).
 *
 * Define NROS_NO_DEPRECATED_CLIENT_ALIASES to compile without any of it.
 *
 * These are scheduled for removal; migrate.
 * =================================================================== */
 
#ifndef NROS_NO_DEPRECATED_CLIENT_ALIASES
 
NROS_DEPRECATED_MSG("nros_client_try_recv_reply_raw() is deprecated; use "
                    "nros_client_take_response_raw()")
static inline int32_t nros_client_try_recv_reply_raw(struct nros_client_t* client, uint8_t* buf,
                                                     size_t buf_len) {
    return nros_client_take_response_raw(client, buf, buf_len);
}
 
NROS_DEPRECATED_MSG("nros_client_try_recv_response() is deprecated; use "
                    "nros_client_take_response()")
static inline nros_ret_t nros_client_try_recv_response(struct nros_client_t* client,
                                                       uint8_t* response_data,
                                                       size_t response_capacity,
                                                       size_t* response_len) {
    return nros_client_take_response(client, response_data, response_capacity, response_len);
}
 
#endif /* NROS_NO_DEPRECATED_CLIENT_ALIASES */
 
#ifdef __cplusplus
}
#endif
 
#endif /* NROS_CLIENT_H */