Skip to content
Snippets Groups Projects
Commit 1001105d authored by Simon Oehrl's avatar Simon Oehrl
Browse files

Adjust readme

#4
parent 2cba37e0
No related branches found
No related tags found
1 merge request!4Feature/#4 add support for a config file
......@@ -18,7 +18,7 @@ The central part of the library is the *Cone* class. During initialization you c
// contra::Relay to the constructor or by using one of the utility function
// provided by Cone. For a full list of this function see the API documentation
// below.
auto cone = cone::ConnectViaSharedMemory();
auto cone = cone::ConnectUsingConfigurationFile("path_to_config_file.json");
// 2.2 Set up callback functions
// Again, see the API description below for a full list of callback functions.
......@@ -51,6 +51,17 @@ Cone ConnectViaSharedMemory(
);
```
### Configuration file
This is the most flexible approach to establishing a connection. The connection
details are stored in a json file at a specified path. It handles all the
previously mentioned cases.
```c++
Cone ConnectUsingConfigurationFile(
const std::string& filename
);
```
Have a look at the files in the folder `example_configurations`.
## Callback functions
All setter methods for the callback functions accept an `std::function` so you can pass raw function pointer, lambdas, etc. The data passed to the callbacks is usually an instance of contuit view defined in `nesci::consumer`. For more information look at the [documentation of nesci](https://devhub.vr.rwth-aachen.de/VR-Group/nesci#consumer).
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment