/usr/include/ns3.27/ns3/ipv4-static-routing-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 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2009 University of Washington
*
* 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
*/
#ifndef IPV4_STATIC_ROUTING_HELPER_H
#define IPV4_STATIC_ROUTING_HELPER_H
#include "ns3/ipv4.h"
#include "ns3/ipv4-static-routing.h"
#include "ns3/ptr.h"
#include "ns3/ipv4-address.h"
#include "ns3/node.h"
#include "ns3/net-device.h"
#include "ns3/ipv4-routing-helper.h"
#include "ns3/node-container.h"
#include "ns3/net-device-container.h"
namespace ns3 {
/**
* \ingroup ipv4Helpers
*
* \brief Helper class that adds ns3::Ipv4StaticRouting objects
*
* This class is expected to be used in conjunction with
* ns3::InternetStackHelper::SetRoutingHelper
*/
class Ipv4StaticRoutingHelper : public Ipv4RoutingHelper
{
public:
/*
* Construct an Ipv4StaticRoutingHelper object, used to make configuration
* of static routing easier.
*/
Ipv4StaticRoutingHelper ();
/**
* \brief Construct an Ipv4StaticRoutingHelper from another previously
* initialized instance (Copy Constructor).
*/
Ipv4StaticRoutingHelper (const Ipv4StaticRoutingHelper &);
/**
* \returns pointer to clone of this Ipv4StaticRoutingHelper
*
* This method is mainly for internal use by the other helpers;
* clients are expected to free the dynamic memory allocated by this method
*/
Ipv4StaticRoutingHelper* 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<Ipv4RoutingProtocol> Create (Ptr<Node> node) const;
/**
* Try and find the static routing protocol as either the main routing
* protocol or in the list of routing protocols associated with the
* Ipv4 provided.
*
* \param ipv4 the Ptr<Ipv4> to search for the static routing protocol
* \returns Ipv4StaticRouting pointer or 0 if not found
*/
Ptr<Ipv4StaticRouting> GetStaticRouting (Ptr<Ipv4> ipv4) const;
/**
* \brief Add a multicast route to a node and net device using explicit
* Ptr<Node> and Ptr<NetDevice>
*
* \param n The node.
* \param source Source address.
* \param group Multicast group.
* \param input Input NetDevice.
* \param output Output NetDevices.
*/
void AddMulticastRoute (Ptr<Node> n, Ipv4Address source, Ipv4Address group,
Ptr<NetDevice> input, NetDeviceContainer output);
/**
* \brief Add a multicast route to a node and device using a name string
* previously associated to the node using the Object Name Service and a
* Ptr<NetDevice>
*
* \param n The node.
* \param source Source address.
* \param group Multicast group.
* \param input Input NetDevice.
* \param output Output NetDevices.
*/
void AddMulticastRoute (std::string n, Ipv4Address source, Ipv4Address group,
Ptr<NetDevice> input, NetDeviceContainer output);
/**
* \brief Add a multicast route to a node and device using a Ptr<Node> and a
* name string previously associated to the device using the Object Name Service.
*
* \param n The node.
* \param source Source address.
* \param group Multicast group.
* \param inputName Input NetDevice.
* \param output Output NetDevices.
*/
void AddMulticastRoute (Ptr<Node> n, Ipv4Address source, Ipv4Address group,
std::string inputName, NetDeviceContainer output);
/**
* \brief Add a multicast route to a node and device using name strings
* previously associated to both the node and device using the Object Name
* Service.
*
* \param nName The node.
* \param source Source address.
* \param group Multicast group.
* \param inputName Input NetDevice.
* \param output Output NetDevices.
*/
void AddMulticastRoute (std::string nName, Ipv4Address source, Ipv4Address group,
std::string inputName, NetDeviceContainer output);
/**
* \brief Add a default route to the static routing protocol to forward
* packets out a particular interface
*
* Functionally equivalent to:
* route add 224.0.0.0 netmask 240.0.0.0 dev nd
* \param n node
* \param nd device of the node to add default route
*/
void SetDefaultMulticastRoute (Ptr<Node> n, Ptr<NetDevice> nd);
/**
* \brief Add a default route to the static routing protocol to forward
* packets out a particular interface
*
* Functionally equivalent to:
* route add 224.0.0.0 netmask 240.0.0.0 dev nd
* \param n node
* \param ndName string with name previously associated to device using the
* Object Name Service
*/
void SetDefaultMulticastRoute (Ptr<Node> n, std::string ndName);
/**
* \brief Add a default route to the static routing protocol to forward
* packets out a particular interface
*
* Functionally equivalent to:
* route add 224.0.0.0 netmask 240.0.0.0 dev nd
* \param nName string with name previously associated to node using the
* Object Name Service
* \param nd device of the node to add default route
*/
void SetDefaultMulticastRoute (std::string nName, Ptr<NetDevice> nd);
/**
* \brief Add a default route to the static routing protocol to forward
* packets out a particular interface
*
* Functionally equivalent to:
* route add 224.0.0.0 netmask 240.0.0.0 dev nd
* \param nName string with name previously associated to node using the
* Object Name Service
* \param ndName string with name previously associated to device using the
* Object Name Service
*/
void SetDefaultMulticastRoute (std::string nName, std::string ndName);
private:
/**
* \brief Assignment operator declared private and not implemented to disallow
* assignment and prevent the compiler from happily inserting its own.
* \returns
*/
Ipv4StaticRoutingHelper &operator = (const Ipv4StaticRoutingHelper &);
};
} // namespace ns3
#endif /* IPV4_STATIC_ROUTING_HELPER_H */
|