summaryrefslogtreecommitdiff
path: root/docs/data/remote/rpc_client.json
diff options
context:
space:
mode:
authorClaudius "keldu" Holeksa <mail@keldu.de>2026-11-07 17:49:12 +0100
committerClaudius "keldu" Holeksa <mail@keldu.de>2026-11-07 17:49:12 +0100
commitbeed9c20da5fbacf8626e2d4b747bb84ae7f6d93 (patch)
tree3835bcdc4180b7e2c68a51f8b1e1c759f298bd1d /docs/data/remote/rpc_client.json
parent25b8bc7c4bbd914f27d745bea07e0bc66c9841b1 (diff)
downloadforstio-forstio-beed9c20da5fbacf8626e2d4b747bb84ae7f6d93.tar.gz
Moved docs around
Diffstat (limited to 'docs/data/remote/rpc_client.json')
-rw-r--r--docs/data/remote/rpc_client.json30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/data/remote/rpc_client.json b/docs/data/remote/rpc_client.json
new file mode 100644
index 0000000..b9dd5ca
--- /dev/null
+++ b/docs/data/remote/rpc_client.json
@@ -0,0 +1,30 @@
+{
+ "format": 1,
+ "id": "saw-rpc_client",
+ "kind": "class",
+ "name": "rpc_client",
+ "namespace": "saw",
+ "module": "remote",
+ "header": "modules/remote/c++/remote.hpp",
+ "brief_description": "Client RPC reference structure.",
+ "detailed_description": [
+ [
+ "The caller side of the overlay. Parameters and return values are moved by the data clients; the rpc layer only ties ids to a function call on the remote."
+ ],
+ [
+ "Only declared by the primary template and defined per backend."
+ ]
+ ],
+ "templates": [
+ {"name": "Iface", "kind": "type", "brief_description": "Interface schema being called."},
+ {"name": "Encoding", "kind": "type", "brief_description": "Encoding of the parameters and responses."},
+ {"name": "Remote", "kind": "type", "brief_description": "Tag type of the backend."}
+ ],
+ "specializations": [
+ {
+ "name": "rpc_client< Iface, Encoding, rmt::Loopback >",
+ "id": "saw-rpc_client-loopback",
+ "brief_description": "Calls a server in the same process, which answers before the call returns."
+ }
+ ]
+}