summaryrefslogtreecommitdiff
path: root/docs_oos/data/remote/remote.json
diff options
context:
space:
mode:
Diffstat (limited to 'docs_oos/data/remote/remote.json')
-rw-r--r--docs_oos/data/remote/remote.json36
1 files changed, 36 insertions, 0 deletions
diff --git a/docs_oos/data/remote/remote.json b/docs_oos/data/remote/remote.json
new file mode 100644
index 0000000..3c9e1a6
--- /dev/null
+++ b/docs_oos/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."
+ }
+ ]
+}