summaryrefslogtreecommitdiff
path: root/docs_oos/data/remote/remote.json
blob: 3c9e1a6165907346a705660decb1f07124a0fd02 (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
35
36
{
	"format": 1,
	"id": "saw-remote",
	"kind": "class",
	"name": "remote",
	"namespace": "saw",
	"module": "remote",
	"header": "modules/remote/c++/remote.hpp",
	"brief_description": "Reference backend structure.",
	"detailed_description": [
		[
			"The primary template is never defined. A backend is added by specializing this class on its tag type, which is the only place the backend itself appears in the public api. An unsupported tag fails with a static_assert instead of a linker error."
		],
		[
			"Every",
			{"name": "data_server", "id": "saw-data_server"},
			"and",
			{"name": "rpc_server", "id": "saw-rpc_server"},
			"of a backend is owned and handed out by its remote, which is also the registry a client searches when it connects."
		]
	],
	"templates": [
		{
			"name": "Remote",
			"kind": "type",
			"brief_description": "Tag type of the backend, e.g. rmt::Loopback."
		}
	],
	"specializations": [
		{
			"name": "remote< rmt::Loopback >",
			"id": "saw-remote-loopback",
			"brief_description": "In process backend. Data stays where it is and calls are answered inline."
		}
	]
}