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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
/*
* Copyright © 2012 Canonical Ltd.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Authored by: Thomas Voß <thomas.voss@canonical.com>
*/
#ifndef CORE_DBUS_DBUS_H_
#define CORE_DBUS_DBUS_H_
#include <core/dbus/visibility.h>
#include <core/dbus/signal.h>
#include <memory>
#include <string>
#include <vector>
namespace core
{
namespace dbus
{
class Bus;
class Object;
class Service;
class ServiceWatcher;
namespace types
{
class ObjectPath;
}
/**
* @brief The DBus class provides access to dbus daemon on the bus.
*/
class ORG_FREEDESKTOP_DBUS_DLL_PUBLIC DBus
{
public:
/**
* @brief The WatchMode enum lists the different watch modes for service registration.
*/
enum class WatchMode
{
registration = 0x01, ///< Notify when a name is newly registered.
unregistration = 0x02, ///< Notify when a name is newly unregistered.
owner_change = 0x03, ///< Notify if the owner name changes at all.
};
/** @brief Query the well-known name of the DBus daemon. */
static const std::string& name();
/** @brief Query the object path of the DBus daemon. */
static const types::ObjectPath& path();
/** @brief Query the interface name of the DBus daemon. */
static const std::string& interface();
DBus(const std::shared_ptr<Bus>& bus);
DBus(const DBus&) = delete;
DBus& operator=(const DBus&) = delete;
bool operator==(const DBus&) const = delete;
/**
* @brief Queries the process ID given a name on the bus.
* @param [in] name Name of the remote peer.
* @return The process id of the remote peer.
*/
uint32_t get_connection_unix_process_id(const std::string& name) const;
/**
* @brief Queries the user ID given a name on the bus.
* @param [in] name Name of the remote peer.
* @return The user id that the remote peer runs under.
*/
uint32_t get_connection_unix_user(const std::string& name) const;
/**
* @brief Say hello to the message bus daemon.
* @return The unique name assigned to this connection.
*/
std::string hello() const;
/**
* @brief List all known names on the bus.
* @return A vector of all known participants on the bus.
*/
std::vector<std::string> list_names() const;
/**
* @brief Create a new service watcher for the specified name and watch mode
* @return Unique instance of ServiceWatcher with the specified parameters
*/
std::unique_ptr<ServiceWatcher> make_service_watcher(
const std::string& name, WatchMode watch_mode =
WatchMode::owner_change);
private:
struct ListNames;
struct Hello;
struct GetConnectionUnixProcessID;
struct GetConnectionUnixUser;
std::shared_ptr<Bus> bus;
std::shared_ptr<Service> service;
std::shared_ptr<Object> object;
};
}
}
#endif // CORE_DBUS_DBUS_H_
|
