OpenCPN Partial API docs
dbus_client.h
1 /***************************************************************************
2  * Copyright (C) 2023 Alec Leamas *
3  * *
4  * This program is free software; you can redistribute it and/or modify *
5  * it under the terms of the GNU General Public License as published by *
6  * the Free Software Foundation; either version 2 of the License, or *
7  * (at your option) any later version. *
8  * *
9  * This program is distributed in the hope that it will be useful, *
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12  * GNU General Public License for more details. *
13  * *
14  * You should have received a copy of the GNU General Public License *
15  * along with this program; if not, write to the *
16  * Free Software Foundation, Inc., *
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
18  ***************************************************************************
19  */
20 
21 #ifndef DBUS_LOCAL_API_H__
22 #define DBUS_LOCAL_API_H__
23 
24 #include <memory>
25 #include <string>
26 #include <thread>
27 #include <utility>
28 
29 #include "model/dbus_server.h"
30 #include "model/local_api.h"
31 
34 public:
35  DbusLocalClient() = default;
36  virtual ~DbusLocalClient() = default;
37 
38  LocalApiResult SendRaise();
39 
40  LocalApiResult SendOpen(const char* path);
41 
42  LocalApiResult SendQuit();
43 
44  LocalApiResult GetRestEndpoint();
45 };
46 
47 #endif // DBUS_LOCAL_API_H__
Implement LocalClientApi on linux using Dbus mechanisms.
Definition: dbus_client.h:33
Base interface for local clients.
Definition: local_api.h:94
DBus interface header file.
The local API has a server side handling commands and a client part issuing commands.