zerodds-endpoint-cpp 1.0 — Spec Coverage

Source: docs/specs/zerodds-endpoint-cpp-1.0.md (226 lines) — the normative C++17 endpoint SDK spec (XRCE framing, sync client, async Reader/Writer, reliable stream). Implemented in endpoints/cpp/: XRCE framing + the sync client over the C89 wire core zdw (endpoints/c), async Reader/Writer as a thin C++17 facade (zerodds_async.hpp), and the header-only reliable stream (zerodds_reliable.hpp). The generated topic_type_support<T> codec comes from crates/lang-rules, column Language::Cpp; this document covers the endpoint that transports it.

§1 XRCE framing

Spec: zerodds-endpoint-cpp-1.0.en.md §1 – DDS-XRCE 1.0 message header (8 bytes: session, stream, seq LE, submsg id, flags, len LE) + body; best-effort stream 0x01.

Repo: endpoints/c/include/zerodds_endpoint.h — zdw_xrce_write_frame / zdw_xrce_read_frame, ZDW_XRCE_SESSION_NOKEY, ZDW_XRCE_STREAM_BEST_EFFORT. The C++ SDK does not re-implement the framing — it binds the C89 wire core directly.

Tests: crates/endpoint-e2e/tests/cpp.rs::xrce_8_3_5_8_cpp_sync_app_writes_the_ping_and_reads_the_pong / xrce_8_3_5_8_cpp_async_app_writes_the_ping_and_reads_the_pong frame and deframe every ping/pong over real UDP.

Status: done.

§2 Sync client

Spec: zerodds-endpoint-cpp-1.0.en.md §2 – A blocking transport-poll client: zdw_endpoint_send / zdw_endpoint_recv over an integrator-supplied zdw_transport (deliver/receive callbacks, ADR-0013 frame hook), marshalling via the C++98 facade zerodds::Writer / zerodds::Reader.

Repo: endpoints/c/include/zerodds_endpoint.h (zdw_transport, zdw_endpoint_send/recv); endpoints/cpp/include/zerodds_wire.hpp (zerodds::Writer/Reader, a C++98 facade over the C89 core); C++ call site crates/endpoint-e2e/tests/cpp.rs::xrce_8_3_5_8_cpp_sync_app_writes_the_ping_and_reads_the_pong (UDP callbacks udp_deliver / udp_receive, 100 ms poll loop for up to 100 iterations); endpoints/cpp/example_sync.cpp (sensor-telemetry deep example Reading{id,value,label}, C++98 poll loop over an in-memory FIFO, full field decode).

Tests: (Linux, g++/gcc gated) xrce_8_3_5_8_cpp_sync_app_writes_the_ping_and_reads_the_pong — live ping-pong E2E against the shared Rust XRCE peer over real UDP; plus endpoint_c_3_4_cpp_generated_codec_pings_without_the_xrce_frame (bare XCDR2, no XRCE framing, a direct codec call through the generated types topic_type_support<Ping>/<Pong> from idl-cpp) as codec build integration for the same app compilation. #[ignore]d in the crate tier, run in the job integration-bindings, where a SKIP line fails the job.

Status: done.

§3 Async Reader/Writer

Spec: zerodds-endpoint-cpp-1.0.en.md §3 – An event-driven, non-blocking reader (a callback per received sample) and a fire-and-forget writer, both thin C++17 facades over the audited C reactor (zerodds_async.c) — additive to the conservative C++98 wire facade (zerodds_wire.hpp).

Repo: endpoints/cpp/include/zerodds_async.hpp — zerodds::AsyncReader (poll() / run(max), RAII, std::function trampoline over zdw_async_reader_init) and zerodds::AsyncWriter (write() over zdw_async_writer_init / zdw_async_write); endpoints/cpp/example_async.cpp (sensor-telemetry deep example, C++17 reactor).

Tests: (Linux, g++/gcc gated) crates/endpoint-e2e/tests/cpp.rs::xrce_8_3_5_8_cpp_async_app_writes_the_ping_and_reads_the_pong — AsyncReader dispatches the received pong to a lambda, AsyncWriter sends the ping; live ping-pong E2E against the Rust peer over real UDP; test name xrce_8_3_5_8_cpp_async_app_writes_the_ping_and_reads_the_pong. Loud skip only when no compiler is on PATH.

Status: done.

§4 Reliable stream — state machine, async writer, loss recovery, byte-golden, latency

Spec: zerodds-endpoint-cpp-1.0.en.md §4 (normative: reliable-endpoint-1.0.en.md) – DDS-XRCE reliable stream (stream_id ≥ 128, §8.4.10/§8.4.11), mirroring the reference crates/xrce/src/reliable.rs: sender submit/pending_heartbeat/recv_acknack/get_in_flight; receiver recv_data/drain_in_order/pending_acknack/reset. The async writer decouples the producer from I/O: enqueue() is wait-free into a lock-free SPSC ring; a dedicated drain thread owns the Sender state, batches WRITE_DATA via sendmmsg, fires HEARTBEATs periodically, and retransmits on ACKNACK. The producer must never enter the kernel on the async-decoupled path — a measurement should show the decoupling against the inline-sendto path (design rationale from reliable-endpoint-1.0.en.md §2).

Repo: endpoints/cpp/include/zerodds_reliable.hpp (381 lines, header-only C++17) — Sender/Receiver state machine, wire codec (write_frame/unframe/acknack_frame/heartbeat_frame/parse_acknack/ parse_heartbeat), AsyncWriter (SPSC ring with std::atomic<size_t> head_/tail_, std::thread drain, enqueue/finish/stop). Pure C++17, header-only; no linking against the Rust layer, cross-compile-safe. endpoints/cpp/example_reliable.cpp (in-process demo: sender + receiver, every 3rd sample dropped in the first round, ACKNACK-driven recovery rounds). endpoints/cpp/test/test_reliable_cpp.cpp (12 unit checks + byte-golden + latency bench).

Tests: (Linux, g++12)

  • reliable_5_1_cpp_state_machine_passes_the_reference_cases_and_the_goldens — 12 unit checks (sender: monotonic seq, payload-too-large, window-full, heartbeat first/silence/period; receiver: acknack-clear, acknack-full-clear, in-order, reorder, duplicate-drop, buffer-full, pending-acknack bitmap, reset) + byte-golden (acknack_frame(0x80, NONE, 1, 1, 0, 0, 0x80) == golden_acknack_le.bin, heartbeat_frame(0x80, NONE, 1, 1, 3, 0x80) == golden_heartbeat_le.bin, 13 bytes each, byte-identical to the Rust-generated goldens) + a latency bench (median over K=20000 iterations: AsyncWriter.enqueue(), no-op drain hooks, no syscall, vs write_frame + inline send to a bound loopback sink; the test checks that the enqueue median stays below the inline median) → ALL OK. The cpp column of tools/endpoints-gate does not build test/test_reliable_cpp.cpp; this test is its only run.
  • reliable_5_3_cpp_samples_arrive_in_order_despite_dropped_datagrams — the Rust peer drops every 3rd datagram; the app retransmits on ACKNACK; 12/12 samples delivered gap-free in order.
  • reliable_5_5_cpp_example_recovers_its_sequence_without_gaps — in-process demo → RELIABLE OK N=16.

Measured earlier: 31–40 ns (enqueue) vs 3427 ns (inline sendto), ~85–110× depending on the run (run-to-run variance, not a single value).

Finding during development: a drain deadlock with no responder — finish() waits until both window and ring are empty, which never happens without an ACKNACK reply. Fixed by adding stop() (unconditional teardown, for responder-less contexts such as the latency bench).

Status: done — sender and receiver state machine unit-verified; the live E2E against the Rust peer covers the sender role (app sends, Rust peer receives + ACKNACKs); the receiver role is verified in-process (example_reliable.cpp), not live-network against an external sender; latency decoupling measured.

§5 Test and evidence obligations

Spec: zerodds-endpoint-cpp-1.0.en.md §5 (mirrors reliable-endpoint-1.0.en.md §5) – unit, byte-golden, E2E loss recovery, a latency bench, a runnable example_reliable_*; no false-green, a loud skip only when the toolchain is missing.

Repo: All five required artifacts present, evidenced in §4: test_reliable_cpp.cpp (unit + byte-golden + latency bench), crates/endpoint-e2e/tests/cpp_reliable.rs (loss recovery against the Rust peer), example_reliable.cpp (a runnable example, not a stub). Loud skip only when g++/gcc is missing from PATH.

Tests: see §4 (reliable_5_1_cpp_state_machine_passes_the_reference_cases_and_the_goldens, reliable_5_3_cpp_samples_arrive_in_order_despite_dropped_datagrams, reliable_5_5_cpp_example_recovers_its_sequence_without_gaps) and §2/§3 (endpoint_c_3_4_cpp_generated_codec_pings_without_the_xrce_frame, xrce_8_3_5_8_cpp_sync_app_writes_the_ping_and_reads_the_pong, xrce_8_3_5_8_cpp_async_app_writes_the_ping_and_reads_the_pong).

Status: done.

Audit status

5 done / 0 partial / 0 open / 0 blocked / 0 n/a (informative).

Test run: in CI, crate tier and pillar jobs; the cited tests with the latest result of each job in the pipelines 8501 to 9053 of main (python3 ci/coverage_results.py --document zerodds-endpoint-cpp-1.0.md):

  • python3 ci/run_integration.py integration-bindings (job integration-bindings) — 6 tests green.

6 cited tests green, 0 not green.

Open items: none.

zerodds-endpoint-cpp 1.0 — Spec-Coverage

Quelle: docs/specs/zerodds-endpoint-cpp-1.0.md (226 Zeilen) — die normative C++17-Endpoint-SDK-Spec (XRCE-Framing, sync Client, async Reader/Writer, reliable Stream). Implementiert in endpoints/cpp/: das XRCE-Framing + der sync Client über den C89-Wire-Core zdw (endpoints/c), async Reader/Writer als dünne C++17-Fassade (zerodds_async.hpp), und der header-only reliable Stream (zerodds_reliable.hpp). Der generierte topic_type_support<T>-Codec kommt aus crates/lang-rules, Spalte Language::Cpp; hier steht der Endpoint, der ihn transportiert.

§1 XRCE-Framing

Spec: zerodds-endpoint-cpp-1.0.md §1 – DDS-XRCE-1.0-Message-Header (8 Byte: session, stream, seq LE, submsg id, flags, len LE) + Body; best-effort Stream 0x01.

Repo: endpoints/c/include/zerodds_endpoint.h — zdw_xrce_write_frame / zdw_xrce_read_frame, ZDW_XRCE_SESSION_NOKEY, ZDW_XRCE_STREAM_BEST_EFFORT. Der C++-SDK re-implementiert das Framing nicht, sondern bindet den C89-Wire-Core direkt ein.

Tests: crates/endpoint-e2e/tests/cpp.rs::xrce_8_3_5_8_cpp_sync_app_writes_the_ping_and_reads_the_pong / xrce_8_3_5_8_cpp_async_app_writes_the_ping_and_reads_the_pong framen bzw. deframen jedes Ping/Pong über echtes UDP.

Status: done.

§2 sync Client

Spec: zerodds-endpoint-cpp-1.0.md §2 – Ein blockierender Transport-Poll-Client: zdw_endpoint_send / zdw_endpoint_recv über einen integrator-gestellten zdw_transport (deliver/receive-Callbacks, ADR-0013-Frame-Hook), Marshalling per C++98-Fassade zerodds::Writer / zerodds::Reader.

Repo: endpoints/c/include/zerodds_endpoint.h (zdw_transport, zdw_endpoint_send/recv); endpoints/cpp/include/zerodds_wire.hpp (zerodds::Writer/Reader, C++98-Fassade über den C89-Kern); C++-Aufrufstelle crates/endpoint-e2e/tests/cpp.rs::xrce_8_3_5_8_cpp_sync_app_writes_the_ping_and_reads_the_pong (UDP-Callbacks udp_deliver / udp_receive, 100-ms-Poll-Loop bis zu 100 Iterationen); endpoints/cpp/example_sync.cpp (Sensor-Telemetrie-Deep-Example Reading{id,value,label}, C++98-Poll-Loop über eine In-Memory-FIFO, voller Feld-Decode).

Tests: (Linux, g++/gcc gated) xrce_8_3_5_8_cpp_sync_app_writes_the_ping_and_reads_the_pong — Live-Ping-Pong-E2E gegen den geteilten Rust-XRCE-Peer über echtes UDP; sowie endpoint_c_3_4_cpp_generated_codec_pings_without_the_xrce_frame (bares XCDR2 ohne XRCE-Framing, direkter Codec-Aufruf über die generierten Typen topic_type_support<Ping>/<Pong> von idl-cpp) als Codec-Build-Integration derselben App-Kompilierung. In der Krate-Ebene #[ignore], im Job integration-bindings gefahren, wo eine SKIP-Zeile den Job scheitern lässt.

Status: done.

§3 async Reader/Writer

Spec: zerodds-endpoint-cpp-1.0.md §3 – Ein event-driven, nicht-blockierender Reader (Callback pro empfangenem Sample) und ein Fire-and-forget-Writer, beide dünne C++17-Fassaden über den auditierten C-Reaktor (zerodds_async.c) — additiv zur konservativen C++98-Wire-Fassade (zerodds_wire.hpp).

Repo: endpoints/cpp/include/zerodds_async.hpp — zerodds::AsyncReader (poll() / run(max), RAII, std::function-Trampolin über zdw_async_reader_init) und zerodds::AsyncWriter (write() über zdw_async_writer_init / zdw_async_write); endpoints/cpp/example_async.cpp (Sensor-Telemetrie-Deep-Example, C++17-Reactor).

Tests: (Linux, g++/gcc gated) crates/endpoint-e2e/tests/cpp.rs::xrce_8_3_5_8_cpp_async_app_writes_the_ping_and_reads_the_pong — AsyncReader dispatcht das empfangene Pong an eine Lambda, AsyncWriter schickt das Ping; Live-Ping-Pong-E2E gegen den Rust-Peer über echtes UDP; Testname xrce_8_3_5_8_cpp_async_app_writes_the_ping_and_reads_the_pong. Lauter Skip nur bei fehlendem Compiler auf dem PATH.

Status: done.

§4 Reliable Stream — State-Machine, Async-Writer, Loss-Recovery, Byte-Golden, Latenz

Spec: zerodds-endpoint-cpp-1.0.md §4 (normativ: reliable-endpoint-1.0.md) – DDS-XRCE reliable Stream (stream_id ≥ 128, §8.4.10/§8.4.11), spiegelt die Referenz crates/xrce/src/reliable.rs: Sender submit/pending_heartbeat/recv_acknack/get_in_flight; Receiver recv_data/drain_in_order/pending_acknack/reset. Der Async-Writer entkoppelt den Producer vom I/O: enqueue() ist wait-free in einen lock-free SPSC-Ring, ein dedizierter Drain-Thread besitzt den Sender-State, batched WRITE_DATA via sendmmsg, feuert HEARTBEATs periodisch und retransmittet auf ACKNACK. Der Producer darf im async-entkoppelten Pfad nie in den Kernel eintreten — ein Messwert soll die Entkopplung gegen den inline-sendto-Pfad zeigen (Design-Motiv aus reliable-endpoint-1.0.md §2).

Repo: endpoints/cpp/include/zerodds_reliable.hpp (381 Zeilen, header-only C++17) — Sender/Receiver-State-Machine, Wire-Codec (write_frame/unframe/acknack_frame/heartbeat_frame/parse_acknack/ parse_heartbeat), AsyncWriter (SPSC-Ring mit std::atomic<size_t> head_/tail_, std::thread-Drain, enqueue/finish/stop). Pure C++17, header-only; kein Linking gegen Rust-Layer, cross-compile-fest. endpoints/cpp/example_reliable.cpp (In-Process-Demo: Sender + Receiver, jedes 3. Sample im ersten Round gedroppt, ACKNACK-getriebene Recovery-Runden). endpoints/cpp/test/test_reliable_cpp.cpp (12 Unit-Checks + Byte-Golden + Latenz-Bench).

Tests: (Linux, g++12)

  • reliable_5_1_cpp_state_machine_passes_the_reference_cases_and_the_goldens — 12 Unit-Checks (Sender: monotone seq, payload-too-large, window-full, heartbeat first/silence/period; Receiver: acknack-clear, acknack-full-clear, in-order, reorder, duplicate-drop, buffer-full, pending-acknack-Bitmap, reset) + Byte-Golden (acknack_frame(0x80, NONE, 1, 1, 0, 0, 0x80) == golden_acknack_le.bin, heartbeat_frame(0x80, NONE, 1, 1, 3, 0x80) == golden_heartbeat_le.bin, je 13 Byte, byte-identisch zu den Rust-generierten Goldens) + Latenz-Bench (Median über K=20000 Iterationen: AsyncWriter.enqueue(), No-op-Drain-Hooks, kein Syscall, vs. write_frame + inline send auf einen gebundenen Loopback-Sink; der Test prüft, dass der Enqueue-Median unter dem inline-Median liegt) → ALL OK. Die Spalte cpp von tools/endpoints-gate baut test/test_reliable_cpp.cpp nicht; dieser Test ist sein einziger Lauf.
  • reliable_5_3_cpp_samples_arrive_in_order_despite_dropped_datagrams — der Rust-Peer dropt jedes 3. Datagramm; App retransmittet auf ACKNACK; 12/12 Samples lückenlos in-order geliefert.
  • reliable_5_5_cpp_example_recovers_its_sequence_without_gaps — In-Process-Demo → RELIABLE OK N=16.

Früher gemessen: 31–40 ns (enqueue) vs. 3427 ns (inline sendto), ~85–110× je nach Lauf (Lauf-zu-Lauf-Streuung, kein Einzelwert).

Fund während der Entwicklung: ein Drain-Deadlock ohne Responder — finish() wartet, bis Fenster und Ring leer sind, was ohne ACKNACK-Antwort nie eintritt. Gefixt durch stop() (unconditionaler Teardown, für responder-lose Kontexte wie den Latenz-Bench).

Status: done — Sender- und Receiver-State-Machine unit-verifiziert; das live-E2E gegen den Rust-Peer deckt die Sender-Rolle ab (App sendet, Rust-Peer empfängt + ACKNACKt); die Receiver-Rolle ist in-process (example_reliable.cpp) verifiziert, nicht live-network gegen einen externen Sender; Latenz-Entkopplung gemessen.

§5 Test- und Beleg-Pflicht

Spec: zerodds-endpoint-cpp-1.0.md §5 (spiegelt reliable-endpoint-1.0.md §5) – Unit, Byte-Golden, E2E-Loss-Recovery, Latenz-Bench, ein lauffähiges example_reliable_*; kein false-green, lauter Skip nur bei fehlender Toolchain.

Repo: Alle fünf Pflicht-Artefakte vorhanden, belegt in §4: test_reliable_cpp.cpp (Unit + Byte-Golden + Latenz-Bench), crates/endpoint-e2e/tests/cpp_reliable.rs (Loss-Recovery gegen den Rust-Peer), example_reliable.cpp (lauffähiges Example, kein Stub). Lauter Skip nur bei fehlendem g++/gcc auf dem PATH.

Tests: siehe §4 (reliable_5_1_cpp_state_machine_passes_the_reference_cases_and_the_goldens, reliable_5_3_cpp_samples_arrive_in_order_despite_dropped_datagrams, reliable_5_5_cpp_example_recovers_its_sequence_without_gaps) sowie §2/§3 (endpoint_c_3_4_cpp_generated_codec_pings_without_the_xrce_frame, xrce_8_3_5_8_cpp_sync_app_writes_the_ping_and_reads_the_pong, xrce_8_3_5_8_cpp_async_app_writes_the_ping_and_reads_the_pong).

Status: done.

Audit-Status

5 done / 0 partial / 0 open / 0 blocked / 0 n/a (informative).

Test-Lauf: in CI, Krate-Ebene und Säulen-Jobs; die zitierten Tests mit dem letzten Ergebnis jedes Jobs in den Pipelines 8501 bis 9053 von main (python3 ci/coverage_results.py --document zerodds-endpoint-cpp-1.0.md):

  • python3 ci/run_integration.py integration-bindings (Job integration-bindings) — 6 Tests grün.

6 zitierte Tests grün, 0 nicht grün.

Offene Punkte: keine.