A Discrete-Event Network Simulator
API
rip-helper.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2016 Universita' di Firenze, Italy
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Tommaso Pecorella <tommaso.pecorella@unifi.it>
19  */
20 
21 #ifndef RIP_HELPER_H
22 #define RIP_HELPER_H
23 
24 #include "ns3/object-factory.h"
25 #include "ns3/ipv4-routing-helper.h"
26 #include "ns3/node-container.h"
27 #include "ns3/node.h"
28 
29 namespace ns3 {
30 
41 {
42 public:
43  /*
44  * Construct an RipHelper to make life easier while adding RIP
45  * routing to nodes.
46  */
47  RipHelper ();
48 
54  RipHelper (const RipHelper &o);
55 
56  virtual ~RipHelper ();
57 
64  RipHelper* Copy (void) const;
65 
72  virtual Ptr<Ipv4RoutingProtocol> Create (Ptr<Node> node) const;
73 
80  void Set (std::string name, const AttributeValue &value);
81 
93  int64_t AssignStreams (NodeContainer c, int64_t stream);
94 
105  void SetDefaultRouter (Ptr<Node> node, Ipv4Address nextHop, uint32_t interface);
106 
118  void ExcludeInterface (Ptr<Node> node, uint32_t interface);
119 
132  void SetInterfaceMetric (Ptr<Node> node, uint32_t interface, uint8_t metric);
133 
134 private:
143 
145 
146  std::map< Ptr<Node>, std::set<uint32_t> > m_interfaceExclusions;
147  std::map< Ptr<Node>, std::map<uint32_t, uint8_t> > m_interfaceMetrics;
148 };
149 
150 } // namespace ns3
151 
152 
153 #endif /* RIP_HELPER_H */
154 
Hold a value for an Attribute.
Definition: attribute.h:69
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:41
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:74
Helper class that adds RIP routing to nodes.
Definition: rip-helper.h:41
void Set(std::string name, const AttributeValue &value)
Definition: rip-helper.cc:81
std::map< Ptr< Node >, std::map< uint32_t, uint8_t > > m_interfaceMetrics
Interface Metric set.
Definition: rip-helper.h:147
std::map< Ptr< Node >, std::set< uint32_t > > m_interfaceExclusions
Interface Exclusion set.
Definition: rip-helper.h:146
RipHelper & operator=(const RipHelper &o)
Assignment operator declared private and not implemented to disallow assignment and prevent the compi...
void ExcludeInterface(Ptr< Node > node, uint32_t interface)
Exclude an interface from RIP protocol.
Definition: rip-helper.cc:159
RipHelper * Copy(void) const
Definition: rip-helper.cc:48
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:88
void SetInterfaceMetric(Ptr< Node > node, uint32_t interface, uint8_t metric)
Set a metric for an interface.
Definition: rip-helper.cc:176
virtual ~RipHelper()
Definition: rip-helper.cc:41
ObjectFactory m_factory
Object Factory.
Definition: rip-helper.h:144
virtual Ptr< Ipv4RoutingProtocol > Create(Ptr< Node > node) const
Definition: rip-helper.cc:54
Every class exported by the ns3 library is enclosed in the ns3 namespace.