Expand description
AUTO-GENERATED by scripts/gen-abi-bindings.sh (bindgen 0.72.1) — DO NOT EDIT.
Source of truth: packages/core/nros-rmw-abi/include/nros/*.h (RFC-0054).
Edit the headers, rerun the script, commit both.
Modules§
- nros_
rmw_ qos_ clash_ t - nros_
rmw_ session_ mode_ t - rmw_
endpoint_ type_ t - rmw_
event_ type_ t - rmw_
feature_ t - rmw_
internet_ protocol_ t - rmw_
liveliness_ kind_ t - rmw_
log_ severity_ t - rmw_
qos_ compatibility_ type_ t - rmw_
transport_ protocol_ t
Structs§
- nros_
rmw_ vtable_ t - nros_
transport_ ops_ s - Runtime-pluggable custom transport. The runtime never
dereferences
user_data; it’s the caller’s per-transport context, threaded back into every callback’s first argument. - rmw_
byte_ span_ t - Global identifier for a publisher — upstream
rmw_gid_t, field for field. - rmw_
client_ t - Client entity (phase-301: renamed from
service_clientto the upstreamrmw_client_tterm). Same shape as the service. - rmw_
count_ status_ t - Count payload. Used for
MESSAGE_LOST,REQUESTED_DEADLINE_MISSED,LIVELINESS_LOST,OFFERED_DEADLINE_MISSED— all share the same shape. - rmw_
gid_ t - rmw_
liveliness_ changed_ status_ t - Liveliness payload. Mirrors the DDS
rmw_liveliness_changed_status_tshape. - rmw_
loan_ token_ t - rmw_
message_ info_ t - Per-sample metadata — upstream
rmw_message_info_t, field for field. - rmw_
message_ type_ support_ t - A message type’s identity — phase-406 W1.
- rmw_
mut_ byte_ span_ t - Room to WRITE — phase-406 W2.
- rmw_
names_ and_ types_ visitor_ t - rmw_
network_ flow_ endpoint_ t - One network flow endpoint — upstream
rmw_network_flow_endpoint_t, field for field. Unlike the graph structs this one carries no pointers, so it costs nothing to mirror exactly and a caller may copy it wholesale. - rmw_
node_ t - A graph node — upstream
rmw_node_t, minus what an image has no use for. - rmw_
node_ visitor_ t - rmw_
publisher_ options_ t - rmw_
publisher_ t - Publisher entity.
- rmw_
qos_ profile_ t - Full DDS-shaped QoS profile.
- rmw_
service_ t - Service entity (phase-301: renamed from
service_serverto the upstreamrmw_service_tterm). - rmw_
service_ type_ support_ t - A service type’s identity. See @ref rmw_message_type_support_t.
- rmw_
session_ options_ t - rmw_
session_ property_ t - Publisher creation options — the home for publisher-side transport
hints (upstream:
rmw_publisher_options_t). Passed as a NULLable trailing param tocreate_publisher; NULL = all defaults. / /** Session creation options — the home for init-time context thatcreate_session’s flat argument list cannot grow without another ABI break (issue 0808). Passed as a NULLable trailing param; NULL = all defaults. - rmw_
session_ t - Per-process RMW session — the entity returned by
vtable->create_session. - rmw_
subscription_ options_ t - Subscription creation options — the home for subscription-side
transport hints (upstream:
rmw_subscription_options_t). Passed as a NULLable trailing param tocreate_subscription; NULL = all defaults. - rmw_
subscription_ t - Subscription entity (phase-301: renamed from
subscriberto the upstreamrmw_subscription_tterm). Same shape as the publisher;can_loan_messagesmeans the backend exposes the receive-side loan primitive. - rmw_
topic_ endpoint_ info_ t - One discovered endpoint — upstream
rmw_topic_endpoint_info_t. - rmw_
topic_ endpoint_ info_ visitor_ t
Constants§
- NROS_
RMW_ DURABILITY_ SYSTEM_ DEFAULT - NROS_
RMW_ DURABILITY_ TRANSIENT_ LOCAL - NROS_
RMW_ DURABILITY_ UNKNOWN - NROS_
RMW_ DURABILITY_ VOLATILE - NROS_
RMW_ DURATION_ INFINITE_ MS - NROS_
RMW_ HISTORY_ KEEP_ ALL - NROS_
RMW_ HISTORY_ KEEP_ LAST - NROS_
RMW_ HISTORY_ SYSTEM_ DEFAULT - NROS_
RMW_ HISTORY_ UNKNOWN - NROS_
RMW_ RELIABILITY_ BEST_ EFFORT - NROS_
RMW_ RELIABILITY_ RELIABLE - NROS_
RMW_ RELIABILITY_ SYSTEM_ DEFAULT - NROS_
RMW_ RELIABILITY_ UNKNOWN - NROS_
RMW_ RET_ AMBIGUOUS_ BACKEND - NROS_
RMW_ RET_ BAD_ ALLOC - NROS_
RMW_ RET_ BUFFER_ TOO_ SMALL - NROS_
RMW_ RET_ CONNECTION_ FAILED - NROS_
RMW_ RET_ ERROR - NROS_
RMW_ RET_ EXTENSION_ BASE - NROS_
RMW_ RET_ INCOMPATIBLE_ ABI - NROS_
RMW_ RET_ INCOMPATIBLE_ QOS - NROS_
RMW_ RET_ INCORRECT_ RMW_ IMPLEMENTATION - NROS_
RMW_ RET_ INVALID_ ARGUMENT - NROS_
RMW_ RET_ INVALID_ CONFIG - NROS_
RMW_ RET_ LOAN_ NOT_ SUPPORTED - NROS_
RMW_ RET_ MESSAGE_ TOO_ LARGE - NROS_
RMW_ RET_ NODE_ NAME_ NON_ EXISTENT - NROS_
RMW_ RET_ NO_ BACKEND - NROS_
RMW_ RET_ NO_ DATA - NROS_
RMW_ RET_ OK - NROS_
RMW_ RET_ TIMEOUT - NROS_
RMW_ RET_ TOPIC_ NAME_ INVALID - NROS_
RMW_ RET_ UNKNOWN_ BACKEND - NROS_
RMW_ RET_ UNSUPPORTED - NROS_
RMW_ RET_ WOULD_ BLOCK - NROS_
RMW_ VISITOR_ DEFINED - RMW_
GID_ STORAGE_ SIZE - RMW_
INET_ ADDRSTRLEN - RMW_
SESSION_ MAX_ PROPERTIES
Functions§
- nros_
rmw_ ⚠cffi_ lookup - Look up a backend’s vtable by name. Returns NULL if no backend is
registered under
name. The returned pointer is valid for the program’s lifetime. - nros_
rmw_ ⚠cffi_ register - Register a custom RMW backend under the implicit name “default”. Legacy single-arg form retained for source compatibility with backend ctors authored before the named registry (Phase 104.B.2).
- nros_
rmw_ ⚠cffi_ register_ named - Phase 104.B.2 — register a backend under a stable name. Multiple
backends can coexist (bridge nodes); consumers select via
nros_rmw_cffi_lookupor the higher-levelExecutor::node_builder(...).rmw(...)path. - nros_
rmw_ ⚠cffi_ registered_ names - Diagnostic helper — fills
bufwith pointers to up tocapregistered backend names. Returns the total number of registered backends (may exceedcap; caller can re-query with a larger buffer). Pointer-valid for the program’s lifetime. Passbuf=NULL, cap=0to query the count only. - nros_
rmw_ ⚠cffi_ set_ custom_ transport - Install a custom transport for subsequent session opens.
- nros_
rmw_ ⚠qos_ incompatibility_ mask - Which policies of
offered(a publisher’s) andrequested(a subscription’s) are incompatible, as a bitmask — no strings, so an image that only needs the verdict never links the reason table. - rmw_
compare_ ⚠gids_ equal - Upstream
rmw_compare_gids_equal. Exact parity. - rmw_
qos_ ⚠profile_ check_ compatible - Upstream
rmw_qos_profile_check_compatible. Exact parity.
Type Aliases§
- nros_
transport_ ops_ t - Runtime-pluggable custom transport. The runtime never
dereferences
user_data; it’s the caller’s per-transport context, threaded back into every callback’s first argument. - rmw_
content_ filter_ visit_ fn - Visit a subscription’s content filter. Return value ignored: there is
exactly one filter per subscription, so this is a callback only to avoid
handing back an allocated
rmw_subscription_content_filter_options_t. - rmw_
event_ callback_ t - Upstream
rmw_event_callback_t— the callback theset_on_new_*slots install. Distinct fromrmw_status_event_callback_tabove, which is the DDS STATUS-event callback; upstream binds this name to this shape and we now match it. - rmw_
names_ and_ types_ visit_ fn - Visit one name and the types on it.
types_countmay legitimately be 0 on a partially discovered graph — reporting the name without a type beats dropping it. Returnfalseto stop. - rmw_
network_ flow_ endpoint_ visit_ fn - Visit one network flow endpoint. Return
falseto stop. - rmw_
node_ visit_ fn - Visit one node.
enclaveis NULL where the backend does not track one — which is what lets a single slot answer bothrmw_get_node_namesandrmw_get_node_names_with_enclaves. Returnfalseto stop. - rmw_
ret_ t - Status code. Zero on success.
- rmw_
status_ event_ callback_ t - rmw_
time_ point_ value_ t - Nanoseconds since a clock’s epoch — upstream’s
rmw_time_point_value_t. - rmw_
topic_ endpoint_ info_ visit_ fn - Visit one discovered endpoint. Return
falseto stop.
Unions§
- rmw_
event_ payload_ t - Borrow-shaped union the backend supplies to the registered
callback. The
kindargument selects which member is valid.