NPRPC docs

NPRPC documentation

Reference for every public declaration in the C++ headers, the Swift package and the IDL, generated from their /// comments, plus the hand-written guides.

Why NPRPC exists

In 2014 I was an industrial automation engineer at a marine oil terminal run on Emerson's DeltaV DCS. Working with that system every day made me want to build my own, smaller, for home automation — and a distributed control system needs RPC of some sort.

The first version sat on DCOM, which was fine until I wanted it off Windows. Then omniORB, which was buggy in the way that ruins a weekend: its thread pool would simply stop spawning threads for new connections. In 2020 I watched Bjarne Stroustrup's “The Beauty and Power of ‘Primitive’ C++” at CppCon, where he writes zero-copy flat-buffer serialization, and it looked simple enough that writing my own RPC stopped sounding crazy.

gRPC was the obvious alternative and I did not want it. HTTP/2 is a fine protocol for services behind a load balancer, but that is not what I was building: I wanted zero-copy messages rather than protobuf parsing, calls that need no reply, and eventually a transport that never touches a socket. gRPC has none of those, and it is a large dependency to take on for their absence. So the first NPRPC was TCP with its own framing and not much else. QUIC, an HTTP/3 server, WebSocket, shared memory, TypeScript and Swift all came later.

Shared memory is the transport that turned out to matter most. It is what the Lava compositor and its apps talk over: a round trip takes about 7 µs, and calls can be fire-and-forget, with no reply to wait for. One IDL file generates both the compositor's C++ servant and the apps' Swift client, so the two sides cannot drift apart.

IDL

44 declarations · 44 documented

Swift

344 declarations · 326 documented

C++

472 declarations · 445 documented

Guides