summaryrefslogtreecommitdiff
path: root/docs/data/remote/i_rpc_server.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/i_rpc_server.json
parent25b8bc7c4bbd914f27d745bea07e0bc66c9841b1 (diff)
downloadforstio-forstio-beed9c20da5fbacf8626e2d4b747bb84ae7f6d93.tar.gz
Moved docs around
Diffstat (limited to 'docs/data/remote/i_rpc_server.json')
-rw-r--r--docs/data/remote/i_rpc_server.json53
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/data/remote/i_rpc_server.json b/docs/data/remote/i_rpc_server.json
new file mode 100644
index 0000000..b648f4c
--- /dev/null
+++ b/docs/data/remote/i_rpc_server.json
@@ -0,0 +1,53 @@
+{
+ "format": 1,
+ "id": "saw-i_rpc_server",
+ "kind": "class",
+ "name": "i_rpc_server",
+ "namespace": "saw",
+ "module": "remote",
+ "header": "modules/remote/c++/remote.hpp",
+ "brief_description": "Registry handle for an rpc server of unknown interface.",
+ "detailed_description": [
+ [
+ "The counterpart of",
+ {"name": "i_data_server", "id": "saw-i_data_server"},
+ "for the rpc layer. It exists so a remote can keep servers of different interfaces in one map and hand back the right one when a client requests it."
+ ],
+ [
+ "Here the class id is the interface hash together with the encoding hash, so connecting with a different interface than the one being served fails instead of reinterpreting the server."
+ ]
+ ],
+ "templates": [
+ {
+ "name": "Remote",
+ "kind": "type",
+ "brief_description": "Tag type of the backend."
+ }
+ ],
+ "functions": {
+ "saw-i_rpc_server-get_class_id": {
+ "id": "saw-i_rpc_server-get_class_id",
+ "name": "get_class_id",
+ "type": ["std::pair< uint32_t, uint32_t >"],
+ "const": true,
+ "virtual": true,
+ "brief_description": "Interface hash and encoding hash of the server behind this handle."
+ },
+ "saw-i_rpc_server-cast_to": {
+ "id": "saw-i_rpc_server-cast_to",
+ "name": "cast_to",
+ "type": ["error_or< ptr< To > >"],
+ "brief_description": "Recovers the concrete server.",
+ "detailed_description": [
+ ["Fails with invalid_state if the class ids don't match."]
+ ],
+ "templates": [
+ {
+ "name": "To",
+ "kind": "type",
+ "brief_description": "The concrete rpc server expected behind this handle."
+ }
+ ]
+ }
+ }
+}