A Discrete-Event Network Simulator
API
rip-helper.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016 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 RIP_HELPER_H
21 #define RIP_HELPER_H
22 
23 #include "ipv4-routing-helper.h"
24 
25 #include "ns3/node-container.h"
26 #include "ns3/node.h"
27 #include "ns3/object-factory.h"
28 
29 namespace ns3
30 {
31 
42 {
43  public:
44  /*
45  * Construct an RipHelper to make life easier while adding RIP
46  * routing to nodes.
47  */
48  RipHelper();
49 
55  RipHelper(const RipHelper& o);
56 
57  ~RipHelper() override;
58 
59  // Delete assignment operator to avoid misuse
60  RipHelper& operator=(const RipHelper&) = delete;
61 
68  RipHelper* Copy() const override;
69 
76  Ptr<Ipv4RoutingProtocol> Create(Ptr<Node> node) const override;
77 
84  void Set(std::string name, const AttributeValue& value);
85 
97  int64_t AssignStreams(NodeContainer c, int64_t stream);
98 
109  void SetDefaultRouter(Ptr<Node> node, Ipv4Address nextHop, uint32_t interface);
110 
122  void ExcludeInterface(Ptr<Node> node, uint32_t interface);
123 
136  void SetInterfaceMetric(Ptr<Node> node, uint32_t interface, uint8_t metric);
137 
138  private:
140 
141  std::map<Ptr<Node>, std::set<uint32_t>> m_interfaceExclusions;
142  std::map<Ptr<Node>, std::map<uint32_t, uint8_t>> m_interfaceMetrics;
143 };
144 
145 } // namespace ns3
146 
147 #endif /* RIP_HELPER_H */
Hold a value for an Attribute.
Definition: attribute.h:70
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:42
a factory to create ns3::Ipv4RoutingProtocol 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 RIP routing to nodes.
Definition: rip-helper.h:42
std::map< Ptr< Node >, std::map< uint32_t, uint8_t > > m_interfaceMetrics
Interface Metric set.
Definition: rip-helper.h:142
~RipHelper() override
Definition: rip-helper.cc:42
Ptr< Ipv4RoutingProtocol > Create(Ptr< Node > node) const override
Definition: rip-helper.cc:55
RipHelper * Copy() const override
Definition: rip-helper.cc:49
RipHelper & operator=(const RipHelper &)=delete
void Set(std::string name, const AttributeValue &value)
Definition: rip-helper.cc:81
void ExcludeInterface(Ptr< Node > node, uint32_t interface)
Exclude an interface from RIP protocol.
Definition: rip-helper.cc:159
void SetDefaultRouter(Ptr< Node > node, Ipv4Address nextHop, uint32_t interface)
Install a default route in the node.
Definition: rip-helper.cc:127
int64_t AssignStreams(NodeContainer c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model.
Definition: rip-helper.cc:87
void SetInterfaceMetric(Ptr< Node > node, uint32_t interface, uint8_t metric)
Set a metric for an interface.
Definition: rip-helper.cc:177
ObjectFactory m_factory
Object Factory.
Definition: rip-helper.h:139
std::map< Ptr< Node >, std::set< uint32_t > > m_interfaceExclusions
Interface Exclusion set.
Definition: rip-helper.h:141
Every class exported by the ns3 library is enclosed in the ns3 namespace.