summaryrefslogtreecommitdiff
path: root/docs/data/remote/remote_address.json
diff options
context:
space:
mode:
Diffstat (limited to 'docs/data/remote/remote_address.json')
-rw-r--r--docs/data/remote/remote_address.json34
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/data/remote/remote_address.json b/docs/data/remote/remote_address.json
new file mode 100644
index 0000000..783527c
--- /dev/null
+++ b/docs/data/remote/remote_address.json
@@ -0,0 +1,34 @@
+{
+ "format": 1,
+ "id": "saw-remote_address",
+ "kind": "class",
+ "name": "remote_address",
+ "namespace": "saw",
+ "module": "remote",
+ "header": "modules/remote/c++/remote.hpp",
+ "brief_description": "Representation of a remote. Partially similar to a network address.",
+ "detailed_description": [
+ [
+ "What an address is depends entirely on the backend. A loopback address is a number, a file address is a path, a socket address is host and port."
+ ],
+ [
+ "Addresses are produced by the parse_address of their own",
+ {"name": "remote", "id": "saw-remote"},
+ "and are meaningless to any other backend."
+ ]
+ ],
+ "templates": [
+ {
+ "name": "Remote",
+ "kind": "type",
+ "brief_description": "Tag type of the backend."
+ }
+ ],
+ "specializations": [
+ {
+ "name": "remote_address< rmt::Loopback >",
+ "id": "saw-remote_address-loopback",
+ "brief_description": "A plain identifier, since there is nothing to address but the process itself."
+ }
+ ]
+}