summaryrefslogtreecommitdiff
path: root/docs/data/remote/remote_data.json
diff options
context:
space:
mode:
Diffstat (limited to 'docs/data/remote/remote_data.json')
-rw-r--r--docs/data/remote/remote_data.json30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/data/remote/remote_data.json b/docs/data/remote/remote_data.json
new file mode 100644
index 0000000..1086ca4
--- /dev/null
+++ b/docs/data/remote/remote_data.json
@@ -0,0 +1,30 @@
+{
+ "format": 1,
+ "id": "saw-remote_data",
+ "kind": "class",
+ "name": "remote_data",
+ "namespace": "saw",
+ "module": "remote",
+ "header": "modules/remote/c++/remote.hpp",
+ "brief_description": "Representing data on the remote.",
+ "detailed_description": [
+ [
+ "What an rpc call hands back. It is an id plus a way to resolve it, not the value, so a result can be passed into the next call without ever being pulled across."
+ ],
+ [
+ "Only declared by the primary template and defined per backend."
+ ]
+ ],
+ "templates": [
+ {"name": "T", "kind": "type", "brief_description": "Schema of the data on the remote."},
+ {"name": "Encoding", "kind": "type"},
+ {"name": "Remote", "kind": "type", "brief_description": "Tag type of the backend."}
+ ],
+ "specializations": [
+ {
+ "name": "remote_data< T, Encoding, rmt::Loopback >",
+ "id": "saw-remote_data-loopback",
+ "brief_description": "Resolves immediately, since the call it came from was answered inline."
+ }
+ ]
+}