A Discrete-Event Network Simulator
API
ripng-helper.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014 Universita' di Firenze, Italy
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation;
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  *
17  * Author: Tommaso Pecorella <tommaso.pecorella@unifi.it>
18  */
19 
20 #ifndef RIPNG_HELPER_H
21 #define RIPNG_HELPER_H
22 
23 #include "ipv6-routing-helper.h"
24 
25 #include "ns3/node-container.h"
26 #include "ns3/node.h"
27 #include "ns3/object-factory.h"
28 
29 #include <map>
30 
31 namespace ns3
32 {
33 
44 {
45  public:
46  /*
47  * Construct an RipNgHelper to make life easier while adding RIPng
48  * routing to nodes.
49  */
50  RipNgHelper();
51 
57  RipNgHelper(const RipNgHelper& o);
58 
59  ~RipNgHelper() override;
60 
61  // Delete assignment operator to avoid misuse
62  RipNgHelper& operator=(const RipNgHelper&) = delete;
63 
70  RipNgHelper* Copy() const override;
71 
78  Ptr<Ipv6RoutingProtocol> Create(Ptr<Node> node) const override;
79 
86  void Set(std::string name, const AttributeValue& value);
87 
99  int64_t AssignStreams(NodeContainer c, int64_t stream);
100 
111  void SetDefaultRouter(Ptr<Node> node, Ipv6Address nextHop, uint32_t interface);
112 
124  void ExcludeInterface(Ptr<Node> node, uint32_t interface);
125 
138  void SetInterfaceMetric(Ptr<Node> node, uint32_t interface, uint8_t metric);
139 
140  private:
142 
143  std::map<Ptr<Node>, std::set<uint32_t>> m_interfaceExclusions;
144  std::map<Ptr<Node>, std::map<uint32_t, uint8_t>> m_interfaceMetrics;
145 };
146 
147 } // namespace ns3
148 
149 #endif /* RIPNG_HELPER_H */
Hold a value for an Attribute.
Definition: attribute.h:70
Describes an IPv6 address.
Definition: ipv6-address.h:49
A factory to create ns3::Ipv6RoutingProtocol objects.
keep track of a set of node pointers.
Instantiate subclasses of ns3::Object.
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:77
Helper class that adds RIPng routing to nodes.
Definition: ripng-helper.h:44
void SetDefaultRouter(Ptr< Node > node, Ipv6Address nextHop, uint32_t interface)
Install a default route in the node.
void ExcludeInterface(Ptr< Node > node, uint32_t interface)
Exclude an interface from RIPng protocol.
Ptr< Ipv6RoutingProtocol > Create(Ptr< Node > node) const override
Definition: ripng-helper.cc:57
int64_t AssignStreams(NodeContainer c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model.
Definition: ripng-helper.cc:89
RipNgHelper * Copy() const override
Definition: ripng-helper.cc:51
void SetInterfaceMetric(Ptr< Node > node, uint32_t interface, uint8_t metric)
Set a metric for an interface.
std::map< Ptr< Node >, std::set< uint32_t > > m_interfaceExclusions
Interface Exclusion set.
Definition: ripng-helper.h:143
void Set(std::string name, const AttributeValue &value)
Definition: ripng-helper.cc:83
~RipNgHelper() override
Definition: ripng-helper.cc:44
RipNgHelper & operator=(const RipNgHelper &)=delete
std::map< Ptr< Node >, std::map< uint32_t, uint8_t > > m_interfaceMetrics
Interface Metric set.
Definition: ripng-helper.h:144
ObjectFactory m_factory
Object Factory.
Definition: ripng-helper.h:141
Every class exported by the ns3 library is enclosed in the ns3 namespace.