/usr/include/ns3.27/ns3/ripng-helper.h is in libns3-dev 3.27+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2014 Universita' di Firenze, Italy
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Author: Tommaso Pecorella <tommaso.pecorella@unifi.it>
*/
#ifndef RIPNG_HELPER_H
#define RIPNG_HELPER_H
#include "ns3/object-factory.h"
#include "ns3/ipv6-routing-helper.h"
#include "ns3/node-container.h"
#include "ns3/node.h"
namespace ns3 {
/**
* \ingroup ipv6Helpers
*
* \brief Helper class that adds RIPng routing to nodes.
*
* This class is expected to be used in conjunction with
* ns3::InternetStackHelper::SetRoutingHelper
*
*/
class RipNgHelper : public Ipv6RoutingHelper
{
public:
/*
* Construct an RipNgHelper to make life easier while adding RIPng
* routing to nodes.
*/
RipNgHelper ();
/**
* \brief Construct an RipNgHelper from another previously
* initialized instance (Copy Constructor).
* \param o The object to copy from.
*/
RipNgHelper (const RipNgHelper &o);
virtual ~RipNgHelper ();
/**
* \returns pointer to clone of this RipNgHelper
*
* This method is mainly for internal use by the other helpers;
* clients are expected to free the dynamic memory allocated by this method
*/
RipNgHelper* Copy (void) const;
/**
* \param node the node on which the routing protocol will run
* \returns a newly-created routing protocol
*
* This method will be called by ns3::InternetStackHelper::Install
*/
virtual Ptr<Ipv6RoutingProtocol> Create (Ptr<Node> node) const;
/**
* \param name the name of the attribute to set
* \param value the value of the attribute to set.
*
* This method controls the attributes of ns3::RipNg
*/
void Set (std::string name, const AttributeValue &value);
/**
* Assign a fixed random variable stream number to the random variables
* used by this model. Return the number of streams (possibly zero) that
* have been assigned. The Install() method should have previously been
* called by the user.
*
* \param c NetDeviceContainer of the set of net devices for which the
* SixLowPanNetDevice should be modified to use a fixed stream
* \param stream first stream index to use
* \return the number of stream indices assigned by this helper
*/
int64_t AssignStreams (NodeContainer c, int64_t stream);
/**
* \brief Install a default route in the node.
*
* The traffic will be routed to the nextHop, located on the specified
* interface, unless a more specific route is found.
*
* \param node the node
* \param nextHop the next hop
* \param interface the network interface
*/
void SetDefaultRouter (Ptr<Node> node, Ipv6Address nextHop, uint32_t interface);
/**
* \brief Exclude an interface from RIPng protocol.
*
* You have to call this function \a before installing RIPng in the nodes.
*
* Note: the exclusion means that RIPng will not be propagated on that interface.
* The network prefix on that interface will be still considered in RIPng.
*
* \param node the node
* \param interface the network interface to be excluded
*/
void ExcludeInterface (Ptr<Node> node, uint32_t interface);
/**
* \brief Set a metric for an interface.
*
* You have to call this function \a before installing RIPng in the nodes.
*
* Note: RIPng will apply the metric on route message reception.
* As a consequence, interface metric should be set on the receiver.
*
* \param node the node
* \param interface the network interface
* \param metric the interface metric
*/
void SetInterfaceMetric (Ptr<Node> node, uint32_t interface, uint8_t metric);
private:
/**
* \brief Assignment operator declared private and not implemented to disallow
* assignment and prevent the compiler from happily inserting its own.
*
* \param o The object to copy from.
* \returns pointer to clone of this RipNgHelper
*/
RipNgHelper &operator = (const RipNgHelper &o);
ObjectFactory m_factory; //!< Object Factory
std::map< Ptr<Node>, std::set<uint32_t> > m_interfaceExclusions; //!< Interface Exclusion set
std::map< Ptr<Node>, std::map<uint32_t, uint8_t> > m_interfaceMetrics; //!< Interface Metric set
};
} // namespace ns3
#endif /* RIPNG_HELPER_H */
|