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
|
// Copyright (C) 2014-2022 Internet Systems Consortium, Inc. ("ISC")
//
// 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/.
#ifndef CLASSIFY_H
#define CLASSIFY_H
#include <cc/data.h>
#include <boost/multi_index_container.hpp>
#include <boost/multi_index/member.hpp>
#include <boost/multi_index/hashed_index.hpp>
#include <boost/multi_index/identity.hpp>
#include <boost/multi_index/ordered_index.hpp>
#include <boost/multi_index/sequenced_index.hpp>
#include <string>
/// @file classify.h
///
/// @brief Defines elements for storing the names of client classes
///
/// This file defines common elements used to track the client classes
/// that may be associated with a given packet. In order to minimize the
/// exposure of the DHCP library to server side concepts such as client
/// classification the classes herein provide a mechanism to maintain lists
/// of class names, rather than the classes they represent. It is the
/// upper layers' prerogative to use these names as they see fit.
///
/// @todo This file should be moved to dhcpsrv eventually as the classification
/// is server side concept. Client has no notion of classifying incoming server
/// messages as it usually talks to only one server. That move is not possible
/// yet, as the Pkt4 and Pkt6 classes have server-side implementation, even
/// though they reside in the dhcp directory.
namespace isc {
namespace dhcp {
/// @brief Defines a single class name.
typedef std::string ClientClass;
/// @brief Tag for the sequence index.
struct ClassSequenceTag { };
/// @brief Tag for the name index.
struct ClassNameTag { };
/// @brief the client class multi-index.
typedef boost::multi_index_container<
ClientClass,
boost::multi_index::indexed_by<
// First index is the sequence one.
boost::multi_index::sequenced<
boost::multi_index::tag<ClassSequenceTag>
>,
// Second index is the name hash one.
boost::multi_index::hashed_unique<
boost::multi_index::tag<ClassNameTag>,
boost::multi_index::identity<ClientClass>
>
>
> ClientClassContainer;
/// @brief Defines a subclass to template class relation.
struct SubClassRelation {
/// @brief Constructor.
SubClassRelation(const ClientClass& class_def, const ClientClass& subclass) :
class_def_(class_def), class_(subclass) {
}
/// @brief The class definition name.
ClientClass class_def_;
/// @brief The class or subclass name.
ClientClass class_;
};
/// @brief Tag for the sequence index.
struct TemplateClassSequenceTag { };
/// @brief Tag for the name index.
struct TemplateClassNameTag { };
/// @brief the subclass multi-index.
typedef boost::multi_index_container<
SubClassRelation,
boost::multi_index::indexed_by<
// First index is the sequence one.
boost::multi_index::sequenced<
boost::multi_index::tag<TemplateClassSequenceTag>
>,
// Second index is the name hash one.
boost::multi_index::hashed_unique<
boost::multi_index::tag<TemplateClassNameTag>,
boost::multi_index::member<SubClassRelation,
ClientClass,
&SubClassRelation::class_def_>
>
>
> SubClassRelationContainer;
/// @brief Container for storing client class names
///
/// Both a list to iterate on it in insert order and unordered
/// set of names for existence.
class ClientClasses {
public:
/// @brief Type of iterators
typedef ClientClassContainer::const_iterator const_iterator;
typedef ClientClassContainer::iterator iterator;
/// @brief Default constructor.
ClientClasses() : container_() {
}
/// @brief Constructor from comma separated values.
///
/// @param class_names A string containing a client classes separated
/// with commas. The class names are trimmed before insertion to the set.
ClientClasses(const std::string& class_names);
/// @brief Insert an element.
///
/// @param class_name The name of the class to insert
void insert(const ClientClass& class_name) {
static_cast<void>(container_.push_back(class_name));
}
/// @brief Erase element by name.
///
/// @param class_name The name of the class to erase.
void erase(const ClientClass& class_name);
/// @brief Check if classes is empty.
bool empty() const {
return (container_.empty());
}
/// @brief Returns the number of classes.
///
/// @note; in C++ 11 list size complexity is constant so
/// there is no advantage to use the set part.
size_t size() const {
return (container_.size());
}
/// @brief Iterators to the first element.
/// @{
const_iterator cbegin() const {
return (container_.cbegin());
}
const_iterator begin() const {
return (container_.begin());
}
iterator begin() {
return (container_.begin());
}
/// @}
/// @brief Iterators to the past the end element.
/// @{
const_iterator cend() const {
return (container_.cend());
}
const_iterator end() const {
return (container_.end());
}
iterator end() {
return (container_.end());
}
/// @}
/// @brief returns if class x belongs to the defined classes
///
/// @param x client class to be checked
/// @return true if x belongs to the classes
bool contains(const ClientClass& x) const;
/// @brief Clears containers.
void clear() {
container_.clear();
}
/// @brief Returns all class names as text
///
/// @param separator Separator to be used between class names. The
/// default separator comprises comma sign followed by space
/// character.
///
/// @return the string representation of all classes
std::string toText(const std::string& separator = ", ") const;
/// @brief Returns all class names as an ElementPtr of type ListElement
///
/// @return the list
isc::data::ElementPtr toElement() const;
private:
/// @brief container part
ClientClassContainer container_;
};
}
}
#endif /* CLASSIFY_H */
|
