/usr/include/ns3/ipv6-interface-container.h is in libns3-dev 3.13+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 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2008-2009 Strasbourg University
*
* 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: Sebastien Vincent <vincent@clarinet.u-strasbg.fr>
*/
#ifndef IPV6_INTERFACE_CONTAINER_H
#define IPV6_INTERFACE_CONTAINER_H
#include <stdint.h>
#include <vector>
#include "ns3/ipv6.h"
#include "ns3/ipv6-address.h"
namespace ns3
{
/**
* \class Ipv6InterfaceContainer
* \brief Keep track of a set of IPv6 interfaces.
*/
class Ipv6InterfaceContainer
{
public:
typedef std::vector<std::pair<Ptr<Ipv6>, uint32_t> >::const_iterator Iterator;
/**
* \brief Constructor.
*/
Ipv6InterfaceContainer ();
/**
* \returns the number of Ptr<Ipv6> and interface pairs stored in this
* Ipv4InterfaceContainer.
*
* Pairs can be retrieved from the container in two ways. First,
* directly by an index into the container, and second, using an iterator.
* This method is used in the direct method and is typically used to
* define an ending condition in a for-loop that runs through the stored
* Nodes
*
* \code
* uint32_t nNodes = container.GetN ();
* for (uint32_t i = 0 i < nNodes; ++i)
* {
* std::pair<Ptr<Ipv6>, uint32_t> pair = container.Get (i);
* method (pair.first, pair.second); // use the pair
* }
* \endcode
*/
uint32_t GetN (void) const;
/**
* \brief Get the interface index for the specified node index.
* \param i index of the node
* \return interface index
*/
uint32_t GetInterfaceIndex (uint32_t i) const;
/**
* \brief Get the address for the specified index.
* \param i interface index
* \param j address index, generally index 0 is the link-local address
* \return IPv6 address
*/
Ipv6Address GetAddress (uint32_t i, uint32_t j) const;
/**
* \brief Add a couple IPv6/interface.
* \param ipv6 IPv6 address
* \param interface interface index
*/
void Add (Ptr<Ipv6> ipv6, uint32_t interface);
/**
* \brief Get an iterator which refers to the first pair in the
* container.
*
* Pairs can be retrieved from the container in two ways. First,
* directly by an index into the container, and second, using an iterator.
* This method is used in the iterator method and is typically used in a
* for-loop to run through the pairs
*
* \code
* Ipv4InterfaceContainer::Iterator i;
* for (i = container.Begin (); i != container.End (); ++i)
* {
* std::pair<Ptr<Ipv6>, uint32_t> pair = *i;
* method (pair.first, pair.second); // use the pair
* }
* \endcode
*
* \returns an iterator which refers to the first pair in the container.
*/
Iterator Begin (void) const;
/**
* \brief Get an iterator which indicates past-the-last Node in the
* container.
*
* Nodes can be retrieved from the container in two ways. First,
* directly by an index into the container, and second, using an iterator.
* This method is used in the iterator method and is typically used in a
* for-loop to run through the Nodes
*
* \code
* NodeContainer::Iterator i;
* for (i = container.Begin (); i != container.End (); ++i)
* {
* std::pair<Ptr<Ipv6>, uint32_t> pair = *i;
* method (pair.first, pair.second); // use the pair
* }
* \endcode
*
* \returns an iterator which indicates an ending condition for a loop.
*/
Iterator End (void) const;
/**
* \brief Fusion with another Ipv6InterfaceContainer.
* \param c container
*/
void Add (Ipv6InterfaceContainer& c);
/**
* \brief Add a couple of name/interface.
* \param ipv6Name name of a node
* \param interface interface index to add
*/
void Add (std::string ipv6Name, uint32_t interface);
/**
* \brief Set the state of the stack (act as a router or not) for the specified index.
* \param i index
* \param router true : is a router, false : is an host
*/
void SetRouter (uint32_t i, bool router);
/**
* \brief Set the default route for the specified index.
* \param i index
* \param router the default router
*/
void SetDefaultRoute (uint32_t i, uint32_t router);
private:
typedef std::vector<std::pair<Ptr<Ipv6>, uint32_t> > InterfaceVector;
/**
* \internal
* \brief List of IPv6 stack and interfaces index.
*/
InterfaceVector m_interfaces;
};
} /* namespace ns3 */
#endif /* IPV6_INTERFACE_CONTAINER_H */
|