From beed9c20da5fbacf8626e2d4b747bb84ae7f6d93 Mon Sep 17 00:00:00 2001 From: "Claudius \"keldu\" Holeksa" Date: Sat, 7 Nov 2026 17:49:12 +0100 Subject: Moved docs around --- docs/data/remote/remote.json | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 docs/data/remote/remote.json (limited to 'docs/data/remote/remote.json') diff --git a/docs/data/remote/remote.json b/docs/data/remote/remote.json new file mode 100644 index 0000000..3c9e1a6 --- /dev/null +++ b/docs/data/remote/remote.json @@ -0,0 +1,36 @@ +{ + "format": 1, + "id": "saw-remote", + "kind": "class", + "name": "remote", + "namespace": "saw", + "module": "remote", + "header": "modules/remote/c++/remote.hpp", + "brief_description": "Reference backend structure.", + "detailed_description": [ + [ + "The primary template is never defined. A backend is added by specializing this class on its tag type, which is the only place the backend itself appears in the public api. An unsupported tag fails with a static_assert instead of a linker error." + ], + [ + "Every", + {"name": "data_server", "id": "saw-data_server"}, + "and", + {"name": "rpc_server", "id": "saw-rpc_server"}, + "of a backend is owned and handed out by its remote, which is also the registry a client searches when it connects." + ] + ], + "templates": [ + { + "name": "Remote", + "kind": "type", + "brief_description": "Tag type of the backend, e.g. rmt::Loopback." + } + ], + "specializations": [ + { + "name": "remote< rmt::Loopback >", + "id": "saw-remote-loopback", + "brief_description": "In process backend. Data stays where it is and calls are answered inline." + } + ] +} -- cgit v1.3.1