summaryrefslogtreecommitdiff
path: root/docs/data/remote/remote_data.loopback.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/remote_data.loopback.json
parent25b8bc7c4bbd914f27d745bea07e0bc66c9841b1 (diff)
downloadforstio-forstio-beed9c20da5fbacf8626e2d4b747bb84ae7f6d93.tar.gz
Moved docs around
Diffstat (limited to 'docs/data/remote/remote_data.loopback.json')
-rw-r--r--docs/data/remote/remote_data.loopback.json70
1 files changed, 70 insertions, 0 deletions
diff --git a/docs/data/remote/remote_data.loopback.json b/docs/data/remote/remote_data.loopback.json
new file mode 100644
index 0000000..32786aa
--- /dev/null
+++ b/docs/data/remote/remote_data.loopback.json
@@ -0,0 +1,70 @@
+{
+ "format": 1,
+ "id": "saw-remote_data-loopback",
+ "kind": "class",
+ "name": "remote_data",
+ "namespace": "saw",
+ "module": "remote",
+ "header": "modules/remote/c++/remote_loopback.hpp",
+ "is_special": true,
+ "specializes": "saw-remote_data",
+ "arguments": ["T", "Encoding", "rmt::Loopback"],
+ "brief_description": "Handle for data which is stored on an in process remote.",
+ "detailed_description": [
+ [
+ "The result of an rpc call. Resolving it goes back through the data layer rather than through the rpc layer, which is why the handle carries the data server and not the rpc server."
+ ],
+ [
+ "This backend answers calls inline, so the data is already present whenever the call succeeded and waiting costs nothing."
+ ]
+ ],
+ "templates": [
+ {"name": "T", "kind": "type"},
+ {"name": "Encoding", "kind": "type"}
+ ],
+ "attributes": {
+ "saw-remote_data-loopback-id_": {
+ "id": "saw-remote_data-loopback-id_",
+ "name": "id_",
+ "type": ["id< T >"],
+ "visibility": "private"
+ },
+ "saw-remote_data-loopback-srv_": {
+ "id": "saw-remote_data-loopback-srv_",
+ "name": "srv_",
+ "type": ["ptr<", {"name": "data_server", "id": "saw-data_server-loopback"}, "< T, Encoding, rmt::Loopback > >"],
+ "visibility": "private"
+ }
+ },
+ "functions": {
+ "saw-remote_data-loopback-get_id": {
+ "id": "saw-remote_data-loopback-get_id",
+ "name": "get_id",
+ "type": ["const id< T > &"],
+ "const": true,
+ "brief_description": "Id of the data on the remote.",
+ "detailed_description": [
+ ["Hand this to the next call to keep a result where it is instead of pulling it across."]
+ ]
+ },
+ "saw-remote_data-loopback-wait": {
+ "id": "saw-remote_data-loopback-wait",
+ "name": "wait",
+ "type": ["error_or< data< T, Encoding > >"],
+ "brief_description": "Waits until the data arrives.",
+ "parameters": [
+ {
+ "name": "wait",
+ "type": ["wait_scope &"],
+ "brief_description": "Unused here, since there is nothing to wait for."
+ }
+ ]
+ },
+ "saw-remote_data-loopback-on_receive": {
+ "id": "saw-remote_data-loopback-on_receive",
+ "name": "on_receive",
+ "type": ["conveyor< data< T, Encoding > >"],
+ "brief_description": "Asynchronously waits for the result."
+ }
+ }
+}