Kea  2.1.7-git
cfg_subnets6.h
Go to the documentation of this file.
1 // Copyright (C) 2014-2022 Internet Systems Consortium, Inc. ("ISC")
2 //
3 // This Source Code Form is subject to the terms of the Mozilla Public
4 // License, v. 2.0. If a copy of the MPL was not distributed with this
5 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
6 
7 #ifndef CFG_SUBNETS6_H
8 #define CFG_SUBNETS6_H
9 
10 #include <asiolink/io_address.h>
11 #include <dhcp/option.h>
12 #include <dhcp/pkt6.h>
13 #include <cc/cfg_to_element.h>
15 #include <dhcpsrv/subnet.h>
16 #include <dhcpsrv/subnet_id.h>
18 #include <util/optional.h>
19 #include <boost/shared_ptr.hpp>
20 #include <string>
21 
22 namespace isc {
23 namespace dhcp {
24 
35 public:
36 
43  void add(const Subnet6Ptr& subnet);
44 
53  Subnet6Ptr replace(const Subnet6Ptr& subnet);
54 
60  void del(const ConstSubnet6Ptr& subnet);
61 
67  void del(const SubnetID& subnet_id);
68 
110  void merge(CfgOptionDefPtr cfg_def, CfgSharedNetworks6Ptr networks,
111  CfgSubnets6& other);
112 
120  const Subnet6Collection* getAll() const {
121  return (&subnets_);
122  }
123 
139  ConstSubnet6Ptr getBySubnetId(const SubnetID& subnet_id) const;
140 
156  ConstSubnet6Ptr getByPrefix(const std::string& subnet_prefix) const;
157 
164  static SubnetSelector initSelector(const Pkt6Ptr& query);
165 
202  Subnet6Ptr selectSubnet(const SubnetSelector& selector) const;
203 
211  Subnet6Ptr getSubnet(const SubnetID id) const;
212 
246  Subnet6Ptr
247  selectSubnet(const asiolink::IOAddress& address,
248  const ClientClasses& client_classes = ClientClasses(),
249  const bool is_relay_address = false) const;
250 
258  void updateStatistics();
259 
266  void removeStatistics();
267 
271  virtual isc::data::ElementPtr toElement() const;
272 
273 private:
274 
294  Subnet6Ptr
295  selectSubnet(const std::string& iface_name,
296  const ClientClasses& client_classes) const;
297 
319  Subnet6Ptr
320  selectSubnet(const OptionPtr& interface_id,
321  const ClientClasses& client_classes) const;
322 
324  Subnet6Collection subnets_;
325 
326 };
327 
329 
330 typedef boost::shared_ptr<CfgSubnets6> CfgSubnets6Ptr;
332 
334 typedef boost::shared_ptr<const CfgSubnets6> ConstCfgSubnets6Ptr;
335 
337 
338 }
339 }
340 
341 #endif // CFG_SUBNETS6_H
boost::shared_ptr< CfgSharedNetworks6 > CfgSharedNetworks6Ptr
Pointer to the configuration of IPv6 shared networks.
ConstSubnet6Ptr getBySubnetId(const SubnetID &subnet_id) const
Returns const pointer to a subnet identified by the specified subnet identifier.
void add(const Subnet6Ptr &subnet)
Adds new subnet to the configuration.
Definition: cfg_subnets6.cc:27
Subnet6Ptr selectSubnet(const SubnetSelector &selector) const
Selects a subnet using parameters specified in the selector.
const Subnet6Collection * getAll() const
Returns pointer to the collection of all IPv6 subnets.
Definition: cfg_subnets6.h:120
Holds subnets configured for the DHCPv6 server.
Definition: cfg_subnets6.h:34
boost::shared_ptr< Option > OptionPtr
Definition: option.h:36
boost::shared_ptr< Element > ElementPtr
Definition: data.h:24
static SubnetSelector initSelector(const Pkt6Ptr &query)
Build selector from a client&#39;s message.
boost::shared_ptr< CfgOptionDef > CfgOptionDefPtr
Non-const pointer.
Subnet selector used to specify parameters used to select a subnet.
void del(const ConstSubnet6Ptr &subnet)
Removes subnet from the configuration.
Definition: cfg_subnets6.cc:66
boost::shared_ptr< Pkt6 > Pkt6Ptr
A pointer to Pkt6 packet.
Definition: pkt6.h:28
Subnet6Ptr getSubnet(const SubnetID id) const
Returns subnet with specified subnet-id value.
boost::shared_ptr< const CfgSubnets6 > ConstCfgSubnets6Ptr
Const pointer.
Definition: cfg_subnets6.h:334
Abstract class for configuration Cfg_* classes.
void merge(CfgOptionDefPtr cfg_def, CfgSharedNetworks6Ptr networks, CfgSubnets6 &other)
Merges specified subnet configuration into this configuration.
Definition: cfg_subnets6.cc:88
boost::shared_ptr< const Subnet6 > ConstSubnet6Ptr
A const pointer to a Subnet6 object.
Definition: subnet.h:666
boost::shared_ptr< CfgSubnets6 > CfgSubnets6Ptr
Non-const pointer.
Definition: cfg_subnets6.h:331
void removeStatistics()
Removes statistics.
boost::multi_index_container< Subnet6Ptr, boost::multi_index::indexed_by< boost::multi_index::ordered_unique< boost::multi_index::tag< SubnetSubnetIdIndexTag >, boost::multi_index::const_mem_fun< Subnet, SubnetID, &Subnet::getID > >, boost::multi_index::ordered_unique< boost::multi_index::tag< SubnetPrefixIndexTag >, boost::multi_index::const_mem_fun< Subnet, std::string, &Subnet::toText > >, boost::multi_index::ordered_non_unique< boost::multi_index::tag< SubnetModificationTimeIndexTag >, boost::multi_index::const_mem_fun< data::BaseStampedElement, boost::posix_time::ptime, &data::BaseStampedElement::getModificationTime > > >> Subnet6Collection
A collection of Subnet6 objects.
Definition: subnet.h:964
Defines the logger used by the top-level component of kea-lfc.
ConstSubnet6Ptr getByPrefix(const std::string &subnet_prefix) const
Returns const pointer to a subnet which matches the specified prefix in the canonical form...
void updateStatistics()
Updates statistics.
Subnet6Ptr replace(const Subnet6Ptr &subnet)
Replaces subnet in the configuration.
Definition: cfg_subnets6.cc:45
boost::shared_ptr< Subnet6 > Subnet6Ptr
A pointer to a Subnet6 object.
Definition: subnet.h:672
Container for storing client class names.
Definition: classify.h:68
virtual isc::data::ElementPtr toElement() const
Unparse a configuration object.
uint32_t SubnetID
Defines unique IPv4 or IPv6 subnet identifier.
Definition: subnet_id.h:24