/usr/include/ns3.17/ns3/ipv4-routing-helper.h is in libns3-dev 3.17+dfsg-1build1.
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 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2008 INRIA
*
* 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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
*/
#ifndef IPV4_ROUTING_HELPER_H
#define IPV4_ROUTING_HELPER_H
#include "ns3/ptr.h"
#include "ns3/nstime.h"
#include "ns3/output-stream-wrapper.h"
namespace ns3 {
class Ipv4RoutingProtocol;
class Node;
/**
* \brief a factory to create ns3::Ipv4RoutingProtocol objects
*
* For each new routing protocol created as a subclass of
* ns3::Ipv4RoutingProtocol, you need to create a subclass of
* ns3::Ipv4RoutingHelper which can be used by
* ns3::InternetStackHelper::SetRoutingHelper and
* ns3::InternetStackHelper::Install.
*/
class Ipv4RoutingHelper
{
public:
/*
* Destroy an instance of an Ipv4RoutingHelper
*/
virtual ~Ipv4RoutingHelper ();
/**
* \brief virtual constructor
* \returns pointer to clone of this Ipv4RoutingHelper
*
* This method is mainly for internal use by the other helpers;
* clients are expected to free the dynamic memory allocated by this method
*/
virtual Ipv4RoutingHelper* Copy (void) const = 0;
/**
* \param node the node within which the new routing protocol will run
* \returns a newly-created routing protocol
*/
virtual Ptr<Ipv4RoutingProtocol> Create (Ptr<Node> node) const = 0;
/**
* \brief prints the routing tables of all nodes at a particular time.
* \param printTime the time at which the routing table is supposed to be printed.
* \param stream The output stream object to use
*
* This method calls the PrintRoutingTable() method of the
* Ipv4RoutingProtocol stored in the Ipv4 object, for all nodes at the
* specified time; the output format is routing protocol-specific.
*/
void PrintRoutingTableAllAt (Time printTime, Ptr<OutputStreamWrapper> stream) const;
/**
* \brief prints the routing tables of all nodes at regular intervals specified by user.
* \param printInterval the time interval for which the routing table is supposed to be printed.
* \param stream The output stream object to use
*
* This method calls the PrintRoutingTable() method of the
* Ipv4RoutingProtocol stored in the Ipv4 object, for all nodes at the
* specified time interval; the output format is routing protocol-specific.
*/
void PrintRoutingTableAllEvery (Time printInterval, Ptr<OutputStreamWrapper> stream) const;
/**
* \brief prints the routing tables of a node at a particular time.
* \param printTime the time at which the routing table is supposed to be printed.
* \param node The node ptr for which we need the routing table to be printed
* \param stream The output stream object to use
*
* This method calls the PrintRoutingTable() method of the
* Ipv4RoutingProtocol stored in the Ipv4 object, for the selected node
* at the specified time; the output format is routing protocol-specific.
*/
void PrintRoutingTableAt (Time printTime, Ptr<Node> node, Ptr<OutputStreamWrapper> stream) const;
/**
* \brief prints the routing tables of a node at regular intervals specified by user.
* \param printInterval the time interval for which the routing table is supposed to be printed.
* \param node The node ptr for which we need the routing table to be printed
* \param stream The output stream object to use
*
* This method calls the PrintRoutingTable() method of the
* Ipv4RoutingProtocol stored in the Ipv4 object, for the selected node
* at the specified interval; the output format is routing protocol-specific.
*/
void PrintRoutingTableEvery (Time printInterval, Ptr<Node> node, Ptr<OutputStreamWrapper> stream) const;
private:
void Print (Ptr<Node> node, Ptr<OutputStreamWrapper> stream) const;
void PrintEvery (Time printInterval, Ptr<Node> node, Ptr<OutputStreamWrapper> stream) const;
};
} // namespace ns3
#endif /* IPV4_ROUTING_HELPER_H */
|