dvs_server_interface.h File Reference
Last update: 17.04.2023C++ Server API for using Dynamic Visualization Store Server. More...
#include <map>#include <string>#include "transport_interface.h"#include "include/dvs_import_export.h"Go to the source code of this file.
Classes | |
| class | DVS::IServer |
| Interface class used to run a dynamic data server in a thread accepting incoming client connections. More... | |
Functions | |
| DVS_DLL_EXPORT IServer * | DVS::CREATE_SERVER_INSTANCE (const char *uri) |
| Create a DVS::IServer instance for clients to connect to. More... | |
| DVS_DLL_EXPORT void | DVS::DESTROY_SERVER_INSTANCE (DVS::IServer *destroy) |
| Destroy the server instance (also shutting it down if needed) More... | |
Detailed Description
C++ Server API for using Dynamic Visualization Store Server.
1.) Instantiate DVS::IServer using DVS::CREATE_SERVER_INSTANCE() method 2.) Set options using DVS::IServer::set_options() or DVS::IServer::set_option() 3.) Startup server using DVS::IServer::startup() 4.) If needed see if it's running via DVS::IServer::running() 5.) Shutdown server using DVS::IServer::shutdown() 6.) Destroy instance using DVS::DESTROY_SERVER_INSTANCE()
Definition in file dvs_server_interface.h.
Function Documentation
◆ CREATE_SERVER_INSTANCE()
| DVS_DLL_EXPORT IServer* DVS::CREATE_SERVER_INSTANCE | ( | const char * | uri | ) |
Create a DVS::IServer instance for clients to connect to.
There are currently 2 types of server communication, grpc over a network or "null" which uses direct method calls.
- Parameters
-
uri URI of server to create of the format protocol://hostname:port, i.e. grpc://localhost:50055 or null:// see Server URIs for more info.
- Returns
- IServer* instance to be later destroyed by calling DVS::DESTROY_SERVER_INSTANCE()
◆ DESTROY_SERVER_INSTANCE()
| DVS_DLL_EXPORT void DVS::DESTROY_SERVER_INSTANCE | ( | DVS::IServer * | destroy | ) |
Destroy the server instance (also shutting it down if needed)
- Parameters
-
destroy DVS::IServer instance to destroy