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
|
/*
* 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_MATCH_RULE_H_
#define CORE_DBUS_MATCH_RULE_H_
#include <core/dbus/message.h>
#include <core/dbus/visibility.h>
#include <core/dbus/types/object_path.h>
#include <memory>
#include <string>
#include <vector>
namespace core
{
namespace dbus
{
/**
* @brief Wraps a DBus match rule.
*/
class ORG_FREEDESKTOP_DBUS_DLL_PUBLIC MatchRule
{
public:
typedef std::pair<std::size_t, std::string> MatchArg;
typedef std::vector<MatchArg> MatchArgs;
/**
* @brief Constructs a valid match rule.
*/
MatchRule();
~MatchRule();
MatchRule(const MatchRule& rhs);
MatchRule& operator=(const MatchRule& rhs);
/**
* @brief Adjusts the message type that this rule applies to.
* @param t The new type
* @return The match rule instance.
*/
MatchRule& type(Message::Type t);
/**
* @brief Adjusts the message type that this rule applies to.
* @param t The new type
* @return A new match rule instance.
*/
MatchRule type(Message::Type t) const;
/**
* @brief Adjusts the sender that this rule applies to.
* @param s The new sender
* @return The match rule instance.
*/
MatchRule& sender(const std::string& s);
/**
* @brief Adjusts the sender that this rule applies to.
* @param s The new sender
* @return A new match rule instance.
*/
MatchRule sender(const std::string& s) const;
/**
* @brief Adjusts the interface that this rule applies to.
* @param i The new interface.
* @return The match rule instance.
*/
MatchRule& interface(const std::string& i);
/**
* @brief Adjusts the interface that this rule applies to.
* @param i The new interface.
* @return A new match rule instance.
*/
MatchRule interface(const std::string& i) const;
/**
* @brief Adjusts the member that this rule applies to.
* @param m The new member.
* @return The match rule instance.
*/
MatchRule& member(const std::string& m);
/**
* @brief Adjusts the member that this rule applies to.
* @param m The new member.
* @return A new match rule instance.
*/
MatchRule member(const std::string& m) const;
/**
* @brief Adjusts the path that this rule applies to.
* @param p The new path.
* @return The match rule instance.
*/
MatchRule& path(const types::ObjectPath& p);
/**
* @brief Adjusts the path that this rule applies to.
* @param p The new path.
* @return A new match rule instance.
*/
MatchRule path(const types::ObjectPath& p) const;
/**
* @brief Adjusts the string method arguments that this rule applies to.
* @param p The new method arguments.
* @return The match rule instance.
*/
MatchRule& args(const MatchArgs& p);
/**
* @brief Adjusts the path that this rule applies to.
* @param p The new path.
* @return A new match rule instance.
*/
MatchRule& args(const MatchArgs& p) const;
/**
* @brief Constructs a valid match rule string from this instance.
* @return A string formatted according to DBus match rule rules.
*/
std::string as_string() const;
private:
struct Private;
std::unique_ptr<Private> d;
};
}
}
#endif // CORE_DBUS_MATCH_RULE_H_
|
