A Discrete-Event Network Simulator
API
ripng-helper.h
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2014 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 RIPNG_HELPER_H
22#define RIPNG_HELPER_H
23
24#include "ns3/object-factory.h"
25#include "ns3/ipv6-routing-helper.h"
26#include "ns3/node-container.h"
27#include "ns3/node.h"
28
29namespace ns3 {
30
41{
42public:
43 /*
44 * Construct an RipNgHelper to make life easier while adding RIPng
45 * routing to nodes.
46 */
47 RipNgHelper ();
48
54 RipNgHelper (const RipNgHelper &o);
55
56 virtual ~RipNgHelper ();
57
58 // Delete assignment operator to avoid misuse
60
67 RipNgHelper* Copy (void) const;
68
75 virtual Ptr<Ipv6RoutingProtocol> Create (Ptr<Node> node) const;
76
83 void Set (std::string name, const AttributeValue &value);
84
96 int64_t AssignStreams (NodeContainer c, int64_t stream);
97
108 void SetDefaultRouter (Ptr<Node> node, Ipv6Address nextHop, uint32_t interface);
109
121 void ExcludeInterface (Ptr<Node> node, uint32_t interface);
122
135 void SetInterfaceMetric (Ptr<Node> node, uint32_t interface, uint8_t metric);
136
137private:
139
140 std::map< Ptr<Node>, std::set<uint32_t> > m_interfaceExclusions;
141 std::map< Ptr<Node>, std::map<uint32_t, uint8_t> > m_interfaceMetrics;
142};
143
144} // namespace ns3
145
146
147#endif /* RIPNG_HELPER_H */
148
Hold a value for an Attribute.
Definition: attribute.h:69
Describes an IPv6 address.
Definition: ipv6-address.h:50
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:78
Helper class that adds RIPng routing to nodes.
Definition: ripng-helper.h:41
virtual ~RipNgHelper()
Definition: ripng-helper.cc:41
std::map< Ptr< Node >, std::set< uint32_t > > m_interfaceExclusions
Interface Exclusion set.
Definition: ripng-helper.h:140
RipNgHelper * Copy(void) const
Definition: ripng-helper.cc:48
std::map< Ptr< Node >, std::map< uint32_t, uint8_t > > m_interfaceMetrics
Interface Metric set.
Definition: ripng-helper.h:141
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.
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:88
void SetInterfaceMetric(Ptr< Node > node, uint32_t interface, uint8_t metric)
Set a metric for an interface.
void Set(std::string name, const AttributeValue &value)
Definition: ripng-helper.cc:81
virtual Ptr< Ipv6RoutingProtocol > Create(Ptr< Node > node) const
Definition: ripng-helper.cc:54
ObjectFactory m_factory
Object Factory.
Definition: ripng-helper.h:138
RipNgHelper & operator=(const RipNgHelper &)=delete
Every class exported by the ns3 library is enclosed in the ns3 namespace.