diff options
| author | Claudius "keldu" Holeksa <mail@keldu.de> | 2026-11-07 17:49:12 +0100 |
|---|---|---|
| committer | Claudius "keldu" Holeksa <mail@keldu.de> | 2026-11-07 17:49:12 +0100 |
| commit | beed9c20da5fbacf8626e2d4b747bb84ae7f6d93 (patch) | |
| tree | 3835bcdc4180b7e2c68a51f8b1e1c759f298bd1d /docs/data/remote/i_data_server.json | |
| parent | 25b8bc7c4bbd914f27d745bea07e0bc66c9841b1 (diff) | |
| download | forstio-forstio-beed9c20da5fbacf8626e2d4b747bb84ae7f6d93.tar.gz | |
Moved docs around
Diffstat (limited to 'docs/data/remote/i_data_server.json')
| -rw-r--r-- | docs/data/remote/i_data_server.json | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/data/remote/i_data_server.json b/docs/data/remote/i_data_server.json new file mode 100644 index 0000000..ecde59c --- /dev/null +++ b/docs/data/remote/i_data_server.json @@ -0,0 +1,53 @@ +{ + "format": 1, + "id": "saw-i_data_server", + "kind": "class", + "name": "i_data_server", + "namespace": "saw", + "module": "remote", + "header": "modules/remote/c++/transfer.hpp", + "brief_description": "Registry handle for a data server of unknown schema.", + "detailed_description": [ + [ + "The one place the library erases a type. A", + {"name": "remote", "id": "saw-remote"}, + "holds servers for many schemas in one map, which is only possible if they share a type. The class id recovers what was erased: a caller which knows the schema it wants asks for exactly that one and gets an error if the stored server is a different one." + ], + [ + "The destructor is protected, so nothing can be deleted through this handle." + ] + ], + "templates": [ + { + "name": "Remote", + "kind": "type", + "brief_description": "Tag type of the backend." + } + ], + "functions": { + "saw-i_data_server-get_class_id": { + "id": "saw-i_data_server-get_class_id", + "name": "get_class_id", + "type": ["std::pair< uint32_t, uint32_t >"], + "const": true, + "virtual": true, + "brief_description": "Schema hash and encoding hash of the server behind this handle." + }, + "saw-i_data_server-cast_to": { + "id": "saw-i_data_server-cast_to", + "name": "cast_to", + "type": ["error_or< ptr< To > >"], + "brief_description": "Recovers the concrete server.", + "detailed_description": [ + ["Fails with invalid_state if the class ids don't match, which is what keeps the erasure honest."] + ], + "templates": [ + { + "name": "To", + "kind": "type", + "brief_description": "The concrete data server expected behind this handle." + } + ] + } + } +} |
