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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
// Copyright (C) 2013-2015 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
#if !defined (COMMONAPI_INTERNAL_COMPILATION)
#error "Only <CommonAPI/CommonAPI.hpp> can be included directly, this file may disappear or change contents."
#endif
#ifndef COMMONAPI_DBUS_DBUS_CONNECTION_HPP_
#define COMMONAPI_DBUS_DBUS_CONNECTION_HPP_
#include <atomic>
#include <dbus/dbus.h>
#include <CommonAPI/DBus/DBusConfig.hpp>
#include <CommonAPI/DBus/DBusDaemonProxy.hpp>
#include <CommonAPI/DBus/DBusMainLoopContext.hpp>
#include <CommonAPI/DBus/DBusObjectManager.hpp>
#include <CommonAPI/DBus/DBusProxyConnection.hpp>
#include <CommonAPI/DBus/DBusServiceRegistry.hpp>
namespace CommonAPI {
namespace DBus {
class DBusObjectManager;
class DBusConnectionStatusEvent
: public DBusProxyConnection::ConnectionStatusEvent {
public:
DBusConnectionStatusEvent(DBusConnection* dbusConnection);
virtual ~DBusConnectionStatusEvent() {}
protected:
virtual void onListenerAdded(const Listener& listener, const Subscription subscription);
// TODO: change to std::weak_ptr<DBusConnection> connection_;
DBusConnection* dbusConnection_;
friend class DBusConnection;
};
struct WatchContext {
WatchContext(std::weak_ptr<MainLoopContext> mainLoopContext, DispatchSource* dispatchSource) :
mainLoopContext_(mainLoopContext), dispatchSource_(dispatchSource) {
}
std::weak_ptr<MainLoopContext> mainLoopContext_;
DispatchSource* dispatchSource_;
};
class DBusConnection
: public DBusProxyConnection,
public std::enable_shared_from_this<DBusConnection> {
public:
COMMONAPI_EXPORT static std::shared_ptr<DBusConnection> getBus(const DBusType_t &_type);
COMMONAPI_EXPORT static std::shared_ptr<DBusConnection> wrap(::DBusConnection *_connection);
COMMONAPI_EXPORT DBusConnection(DBusType_t _type);
COMMONAPI_EXPORT DBusConnection(const DBusConnection&) = delete;
COMMONAPI_EXPORT DBusConnection(::DBusConnection* libDbusConnection);
COMMONAPI_EXPORT virtual ~DBusConnection();
COMMONAPI_EXPORT DBusConnection& operator=(const DBusConnection&) = delete;
COMMONAPI_EXPORT DBusType_t getBusType() const;
COMMONAPI_EXPORT bool connect(bool startDispatchThread = true);
COMMONAPI_EXPORT bool connect(DBusError& dbusError, bool startDispatchThread = true);
COMMONAPI_EXPORT void disconnect();
COMMONAPI_EXPORT virtual bool isConnected() const;
COMMONAPI_EXPORT virtual ConnectionStatusEvent& getConnectionStatusEvent();
COMMONAPI_EXPORT virtual bool requestServiceNameAndBlock(const std::string& serviceName) const;
COMMONAPI_EXPORT virtual bool releaseServiceName(const std::string& serviceName) const;
COMMONAPI_EXPORT bool sendDBusMessage(const DBusMessage& dbusMessage/*, uint32_t* allocatedSerial = NULL*/) const;
COMMONAPI_EXPORT std::future<CallStatus> sendDBusMessageWithReplyAsync(
const DBusMessage& dbusMessage,
std::unique_ptr<DBusMessageReplyAsyncHandler> dbusMessageReplyAsyncHandler,
const CommonAPI::CallInfo *_info) const;
COMMONAPI_EXPORT DBusMessage sendDBusMessageWithReplyAndBlock(const DBusMessage& dbusMessage,
DBusError& dbusError,
const CommonAPI::CallInfo *_info) const;
COMMONAPI_EXPORT virtual bool addObjectManagerSignalMemberHandler(const std::string& dbusBusName,
DBusSignalHandler* dbusSignalHandler);
COMMONAPI_EXPORT virtual bool removeObjectManagerSignalMemberHandler(const std::string& dbusBusName,
DBusSignalHandler* dbusSignalHandler);
COMMONAPI_EXPORT DBusSignalHandlerToken addSignalMemberHandler(const std::string& objectPath,
const std::string& interfaceName,
const std::string& interfaceMemberName,
const std::string& inuint32_tterfaceMemberSignature,
DBusSignalHandler* dbusSignalHandler,
const bool justAddFilter = false);
COMMONAPI_EXPORT DBusProxyConnection::DBusSignalHandlerToken subscribeForSelectiveBroadcast(bool& subscriptionAccepted,
const std::string& objectPath,
const std::string& interfaceName,
const std::string& interfaceMemberName,
const std::string& interfaceMemberSignature,
DBusSignalHandler* dbusSignalHandler,
DBusProxy* callingProxy);
COMMONAPI_EXPORT void unsubscribeFromSelectiveBroadcast(const std::string& eventName,
DBusProxyConnection::DBusSignalHandlerToken subscription,
DBusProxy* callingProxy,
const DBusSignalHandler* dbusSignalHandler);
COMMONAPI_EXPORT void registerObjectPath(const std::string& objectPath);
COMMONAPI_EXPORT void unregisterObjectPath(const std::string& objectPath);
COMMONAPI_EXPORT bool removeSignalMemberHandler(const DBusSignalHandlerToken& dbusSignalHandlerToken,
const DBusSignalHandler* dbusSignalHandler = NULL);
COMMONAPI_EXPORT bool readWriteDispatch(int timeoutMilliseconds = -1);
COMMONAPI_EXPORT virtual const std::shared_ptr<DBusObjectManager> getDBusObjectManager();
COMMONAPI_EXPORT void setObjectPathMessageHandler(DBusObjectPathMessageHandler);
COMMONAPI_EXPORT bool isObjectPathMessageHandlerSet();
COMMONAPI_EXPORT virtual bool attachMainLoopContext(std::weak_ptr<MainLoopContext>);
COMMONAPI_EXPORT bool isDispatchReady();
COMMONAPI_EXPORT bool singleDispatch();
COMMONAPI_EXPORT virtual bool hasDispatchThread();
typedef std::tuple<std::string, std::string, std::string> DBusSignalMatchRuleTuple;
typedef std::pair<uint32_t, std::string> DBusSignalMatchRuleMapping;
typedef std::unordered_map<DBusSignalMatchRuleTuple, DBusSignalMatchRuleMapping> DBusSignalMatchRulesMap;
private:
COMMONAPI_EXPORT void dispatch();
COMMONAPI_EXPORT void suspendDispatching() const;
COMMONAPI_EXPORT void resumeDispatching() const;
std::thread* dispatchThread_;
bool stopDispatching_;
std::weak_ptr<MainLoopContext> mainLoopContext_;
DispatchSource* dispatchSource_;
WatchContext* watchContext_;
mutable std::recursive_mutex sendLock_;
mutable bool pauseDispatching_;
mutable std::mutex dispatchSuspendLock_;
COMMONAPI_EXPORT void addLibdbusSignalMatchRule(const std::string& objectPath,
const std::string& interfaceName,
const std::string& interfaceMemberName,
const bool justAddFilter = false);
COMMONAPI_EXPORT void removeLibdbusSignalMatchRule(const std::string& objectPath,
const std::string& interfaceName,
const std::string& interfaceMemberName);
COMMONAPI_EXPORT void initLibdbusSignalFilterAfterConnect();
::DBusHandlerResult onLibdbusSignalFilter(::DBusMessage* libdbusMessage);
COMMONAPI_EXPORT void initLibdbusObjectPathHandlerAfterConnect();
::DBusHandlerResult onLibdbusObjectPathMessage(::DBusMessage* libdbusMessage);
COMMONAPI_EXPORT static DBusMessage convertToDBusMessage(::DBusPendingCall* _libdbusPendingCall,
CallStatus& _callStatus);
COMMONAPI_EXPORT static void onLibdbusPendingCallNotifyThunk(::DBusPendingCall* libdbusPendingCall, void* userData);
COMMONAPI_EXPORT static void onLibdbusDataCleanup(void* userData);
COMMONAPI_EXPORT static ::DBusHandlerResult onLibdbusObjectPathMessageThunk(::DBusConnection* libdbusConnection,
::DBusMessage* libdbusMessage,
void* userData);
COMMONAPI_EXPORT static ::DBusHandlerResult onLibdbusSignalFilterThunk(::DBusConnection* libdbusConnection,
::DBusMessage* libdbusMessage,
void* userData);
COMMONAPI_EXPORT static dbus_bool_t onAddWatch(::DBusWatch* libdbusWatch, void* data);
COMMONAPI_EXPORT static void onRemoveWatch(::DBusWatch* libdbusWatch, void* data);
COMMONAPI_EXPORT static void onToggleWatch(::DBusWatch* libdbusWatch, void* data);
COMMONAPI_EXPORT static dbus_bool_t onAddTimeout(::DBusTimeout* dbus_timeout, void* data);
COMMONAPI_EXPORT static void onRemoveTimeout(::DBusTimeout* dbus_timeout, void* data);
COMMONAPI_EXPORT static void onToggleTimeout(::DBusTimeout* dbus_timeout, void* data);
COMMONAPI_EXPORT static void onWakeupMainContext(void* data);
COMMONAPI_EXPORT void enforceAsynchronousTimeouts() const;
COMMONAPI_EXPORT static const DBusObjectPathVTable* getDBusObjectPathVTable();
::DBusConnection* connection_;
mutable std::mutex connectionGuard_;
std::mutex signalGuard_;
std::mutex objectManagerGuard_;
std::mutex serviceRegistryGuard_;
DBusType_t busType_;
std::shared_ptr<DBusObjectManager> dbusObjectManager_;
DBusConnectionStatusEvent dbusConnectionStatusEvent_;
DBusSignalMatchRulesMap dbusSignalMatchRulesMap_;
DBusSignalHandlerTable dbusSignalHandlerTable_;
std::unordered_map<std::string, size_t> dbusObjectManagerSignalMatchRulesMap_;
std::unordered_multimap<std::string, DBusSignalHandler*> dbusObjectManagerSignalHandlerTable_;
std::mutex dbusObjectManagerSignalGuard_;
COMMONAPI_EXPORT bool addObjectManagerSignalMatchRule(const std::string& dbusBusName);
COMMONAPI_EXPORT bool removeObjectManagerSignalMatchRule(const std::string& dbusBusName);
COMMONAPI_EXPORT bool addLibdbusSignalMatchRule(const std::string& dbusMatchRule);
COMMONAPI_EXPORT bool removeLibdbusSignalMatchRule(const std::string& dbusMatchRule);
std::atomic_size_t libdbusSignalMatchRulesCount_;
// objectPath, referenceCount
typedef std::unordered_map<std::string, uint32_t> LibdbusRegisteredObjectPathHandlersTable;
LibdbusRegisteredObjectPathHandlersTable libdbusRegisteredObjectPaths_;
DBusObjectPathMessageHandler dbusObjectMessageHandler_;
mutable std::unordered_map<std::string, uint16_t> connectionNameCount_;
typedef std::pair<
DBusPendingCall*,
std::tuple<
std::chrono::time_point<std::chrono::high_resolution_clock>,
DBusMessageReplyAsyncHandler*,
DBusMessage
>
> TimeoutMapElement;
mutable std::map<
DBusPendingCall*,
std::tuple<
std::chrono::time_point<std::chrono::high_resolution_clock>,
DBusMessageReplyAsyncHandler*,
DBusMessage
>
> timeoutMap_;
typedef std::tuple<
DBusMessageReplyAsyncHandler *,
DBusMessage,
CommonAPI::CallStatus,
::DBusPendingCall*
> MainloopTimeout_t;
mutable std::list<MainloopTimeout_t> mainloopTimeouts_;
mutable std::mutex enforceTimeoutMutex_;
mutable std::condition_variable enforceTimeoutCondition_;
mutable std::shared_ptr<std::thread> enforcerThread_;
mutable std::mutex enforcerThreadMutex_;
bool enforcerThreadCancelled_;
};
} // namespace DBus
} // namespace CommonAPI
#endif // COMMONAPI_DBUS_DBUS_CONNECTION_HPP_
|
