Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Crate index

Reference · generated · every workspace crate by tier, with the description its manifest carries

A tier depends only on the tiers below it; the peripheral surface depends on all of them and is depended on by none. The description column is each crate’s Cargo.toml description, so this table is exactly what cargo metadata reports. The status column is the crate’s package.metadata.pulse-mesh.status: pre-integration for a crate the tree ships but does not use yet (ADR-0014), partial for one in use some of whose public entry points return a deferred error (ADR-0017), blank for one that is finished and wired in.

The enterprise ring (tier 3, rings/enterprise_ring/)

CratePathStatusDescription
enterprise-corerings/enterprise_ring/enterprise-corePulse Mesh — enterprise_ring core layer: shared types for the ring’s functions and stages. Empty by design; kept so the four-crate shape is uniform.
enterprise-functionsrings/enterprise_ring/enterprise-functionsPulse Mesh — enterprise_ring functions layer: stateless primitives. Empty by design; kept so the four-crate shape is uniform.
enterprise-hubrings/enterprise_ring/enterprise-hubPulse Mesh — enterprise_ring hub layer: the ring’s import point; re-exports core, functions and stages and emits the ring manifest.
enterprise-stagesrings/enterprise_ring/enterprise-stagespartialPulse Mesh — enterprise_ring stages layer: the wire transport’s frames over TLS 1.3 on TCP (rustls), with the DTLS and QUIC-tunnel modes deferred.

The HFT ring (tier 3, rings/hft_ring/)

CratePathStatusDescription
hft-corerings/hft_ring/hft-corePulse Mesh — hft_ring core layer: cache-line prefetch hints and the version-2 slot constants; no state, no I/O.
hft-functionsrings/hft_ring/hft-functionsPulse Mesh — hft_ring functions layer: the WaitStrategy trait with BusySpin, Park and the opt-in UMWAIT, MWAITX and WFE backends.
hft-hubrings/hft_ring/hft-hubPulse Mesh — hft_ring hub layer: the ring’s import point; re-exports core, functions and stages and emits the ring manifest.
hft-stagesrings/hft_ring/hft-stagesPulse Mesh — hft_ring stages layer: NUMA hugepage placement, the MultiLane striped rings and the SPMC ring.

The robotics ring (tier 3, rings/robotics_ring/)

CratePathStatusDescription
robotics-corerings/robotics_ring/robotics-corePulse Mesh — robotics_ring core layer: shared types for the ring’s functions and stages. Empty by design; kept so the four-crate shape is uniform.
robotics-functionsrings/robotics_ring/robotics-functionsPulse Mesh — robotics_ring functions layer: stateless primitives. Empty by design; kept so the four-crate shape is uniform.
robotics-hubrings/robotics_ring/robotics-hubPulse Mesh — robotics_ring hub layer: the ring’s import point; re-exports core, functions and stages and emits the ring manifest.
robotics-stagesrings/robotics_ring/robotics-stagesPulse Mesh — robotics_ring stages layer: the out-of-band large-payload pool in shared memory, a UDP transport over io_uring with a pool of persistent TCP flows, and lag-driven ring autoscaling, which resizes a ring by replacing it under its name.

The peripheral surface (tier peripheral, tools/, examples/, plugins/)

CratePathStatusDescription
example-enterprise-01-tls-stage-rustexamples/enterprise-01-tls-stage-rustExample — the enterprise ring’s TLS stage reached through its hub: a TLS 1.3 handshake on loopback with a certificate the example makes, one frame sent and received, and what the deferred DTLS mode reports.
example-robotics-01-large-payload-rustexamples/robotics-01-large-payload-rustExample — the robotics ring’s large-payload pool reached through its hub: a 4 MiB scan written in one process and read in another, its 16-byte reference carried in a Pulse’s data area, and the segment freed for the next scan.
pms-telemetrytools/hft-telemetryPulse Mesh scheduling-pressure probes for the hft ring’s wait strategies: a PSI probe reading /proc/pressure/cpu on Linux, and an adaptive strategy that parks while pressure is high.
pulse-wire-xdpplugins/hft-xdpThe Pulse Mesh UDP transport’s frames over AF_XDP on Linux: a sender that writes them into a NIC queue’s TX ring, and a receiver whose XDP program hands it the queue’s packets for its port.