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
|
/*
* 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_SIGNAL_H_
#define CORE_DBUS_SIGNAL_H_
#include <core/signal.h>
#include <core/dbus/match_rule.h>
#include <core/dbus/message.h>
#include <core/dbus/visibility.h>
#include <functional>
#include <memory>
#include <mutex>
#include <string>
#include <list>
namespace core
{
namespace dbus
{
class Object;
template<typename T>
struct is_not_void
{
static const bool value = true;
};
template<>
struct is_not_void<void>
{
static const bool value = false;
};
/**
* @brief Template class Signal models a type-safe DBus signal.
* @tparam SignalDescription Needs to be a model of concept SignalDescription.
* @tparam Argument The type of the argument that is emitted by this signal.
*/
template<typename SignalDescription, typename Argument = void>
class Signal
{
public:
typedef std::shared_ptr<Signal<SignalDescription, void>> Ptr;
/**
* @brief Handler defines the function signature for change callbacks.
*/
typedef std::function<void()> Handler;
/**
* @brief SubscriptionToken is a type that refers to a signal-slot connection.
*/
typedef typename std::list<Handler>::iterator SubscriptionToken;
inline ~Signal() noexcept;
/**
* @brief Emits the signal.
*/
inline void emit(void);
/**
* @brief connect creates a connection to the provided handler.
* @param h The handler to be invoked when the signal is emitted.
* @return A token that corresponds to the signal-slot connection.
*/
inline SubscriptionToken connect(const Handler& h);
/**
* @brief disconnect releases a signal-slot connection
* @param token Refers to the signal-slot connection that should be released.
*/
inline void disconnect(const SubscriptionToken& token);
inline const core::Signal<void>& about_to_be_destroyed() const;
protected:
friend class Object;
inline static std::shared_ptr<Signal<SignalDescription, void>>
make_signal(
const std::shared_ptr<Object>& parent,
const std::string& interface,
const std::string& name);
private:
inline Signal(const std::shared_ptr<Object>& parent,
const std::string& interface,
const std::string& name);
void operator()(const Message::Ptr&);
std::shared_ptr<Object> parent;
std::string interface;
std::string name;
MatchRule rule;
std::mutex handlers_guard;
std::list<Handler> handlers;
core::Signal<void> signal_about_to_be_destroyed;
};
/**
* @brief Template class Signal models a type-safe DBus signal.
* @tparam SignalDescription Needs to be a model of concept SignalDescription.
* @tparam Argument The type of the argument that is emitted by this signal.
*/
template<typename SignalDescription>
class Signal<
SignalDescription,
typename std::enable_if<
is_not_void<typename SignalDescription::ArgumentType>::value,
typename SignalDescription::ArgumentType>::type
>
{
public:
typedef std::shared_ptr<Signal<SignalDescription, typename SignalDescription::ArgumentType>> Ptr;
/**
* @brief Handler defines the function signature for change callbacks.
*/
typedef std::function<void(const typename SignalDescription::ArgumentType&)> Handler;
/**
* @brief SubscriptionToken is a type that refers to a signal-slot connection.
*/
typedef typename std::multimap<MatchRule::MatchArgs, Handler>::iterator SubscriptionToken;
inline ~Signal() noexcept;
/**
* @brief Emits the signal with the provided argument.
* @param [in] arg The parameter to be passed over to handlers.
*/
inline void emit(const typename SignalDescription::ArgumentType& arg);
/**
* @brief connect creates a connection to the provided handler.
* @param h The handler to be invoked when the signal is emitted.
* @return A token that corresponds to the signal-slot connection.
*/
inline SubscriptionToken connect(const Handler& h);
inline SubscriptionToken connect_with_match_args(const Handler& h, const MatchRule::MatchArgs& match_args);
/**
* @brief disconnect releases a signal-slot connection
* @param token Refers to the signal-slot connection that should be released.
*/
inline void disconnect(const SubscriptionToken& token);
inline const core::Signal<void>& about_to_be_destroyed() const;
protected:
friend class Object;
inline static std::shared_ptr<Signal<SignalDescription,typename SignalDescription::ArgumentType>>
make_signal(
const std::shared_ptr<Object>& parent,
const std::string& interface,
const std::string& name);
private:
inline Signal(
const std::shared_ptr<Object>& parent,
const std::string& interface,
const std::string& name);
inline void operator()(const Message::Ptr&) noexcept;
struct ORG_FREEDESKTOP_DBUS_DLL_LOCAL Shared
{
Shared(
const std::shared_ptr<Object>& parent,
const std::string& interface,
const std::string& name);
// We do not need this member anymore, but keep it in place for
// the sake of binary compatibility. Leaving a TODO(tvoss) to clean
// up on next ABI bump.
typename SignalDescription::ArgumentType pad;
std::shared_ptr<Object> parent;
std::string interface;
std::string name;
MatchRule rule;
std::mutex handlers_guard;
std::multimap<MatchRule::MatchArgs, Handler> handlers;
core::Signal<void> signal_about_to_be_destroyed;
};
std::shared_ptr<Shared> d;
};
}
}
#include "impl/signal.h"
#endif // CORE_DBUS_SIGNAL_H_
|
