summaryrefslogtreecommitdiff
path: root/docs/data/remote/remote_address.json
blob: 783527c6db7c844ae5731d6da232f172e9a3b3e2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
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."
		}
	]
}