/usr/include/ns3.27/ns3/radvd.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 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2008 Telecom Bretagne
* Copyright (c) 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>
* Mehdi Benamor <benamor.mehdi@ensi.rnu.tn>
*/
#ifndef RADVD_H
#define RADVD_H
#include <map>
#include "radvd-interface.h"
#include "ns3/application.h"
#include "ns3/socket.h"
#include "ns3/random-variable-stream.h"
namespace ns3
{
/**
* \ingroup internet-apps
* \defgroup radvd Radvd
*/
/**
* \ingroup radvd
* \brief Router advertisement daemon.
*/
class Radvd : public Application
{
public:
/**
* \brief Get the type ID.
* \return type ID
*/
static TypeId GetTypeId (void);
/**
* \brief Constructor.
*/
Radvd ();
/**
* \brief Destructor.
*/
virtual ~Radvd ();
/**
* \brief Default value for maximum delay of RA (ms)
*/
static const uint32_t MAX_RA_DELAY_TIME = 500;
/**
* \brief Default value for maximum initial RA advertisements
*/
static const uint32_t MAX_INITIAL_RTR_ADVERTISEMENTS = 3;
/**
* \brief Default value for maximum initial RA advertisements interval (ms)
*/
static const uint32_t MAX_INITIAL_RTR_ADVERT_INTERVAL = 16000;
/**
* \brief Default value for minimum delay between RA advertisements (ms)
*/
static const uint32_t MIN_DELAY_BETWEEN_RAS = 3000;
/**
* \brief Add configuration for an interface;
* \param routerInterface configuration
*/
void AddConfiguration (Ptr<RadvdInterface> routerInterface);
/**
* 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.
*
* \param stream first stream index to use
* \return the number of stream indices assigned by this model
*/
int64_t AssignStreams (int64_t stream);
protected:
/**
* \brief Dispose the instance.
*/
virtual void DoDispose ();
private:
/// Container: Ptr to RadvdInterface
typedef std::list<Ptr<RadvdInterface> > RadvdInterfaceList;
/// Container Iterator: Ptr to RadvdInterface
typedef std::list<Ptr<RadvdInterface> >::iterator RadvdInterfaceListI;
/// Container Const Iterator: Ptr to RadvdInterface
typedef std::list<Ptr<RadvdInterface> >::const_iterator RadvdInterfaceListCI;
/// Container: interface number, EventId
typedef std::map<uint32_t, EventId> EventIdMap;
/// Container Iterator: interface number, EventId
typedef std::map<uint32_t, EventId>::iterator EventIdMapI;
/// Container Const Iterator: interface number, EventId
typedef std::map<uint32_t, EventId>::const_iterator EventIdMapCI;
/// Container: interface number, Socket
typedef std::map<uint32_t, Ptr<Socket> > SocketMap;
/// Container Iterator: interface number, Socket
typedef std::map<uint32_t, Ptr<Socket> >::iterator SocketMapI;
/// Container Const Iterator: interface number, Socket
typedef std::map<uint32_t, Ptr<Socket> >::const_iterator SocketMapCI;
/**
* \brief Start the application.
*/
virtual void StartApplication ();
/**
* \brief Stop the application.
*/
virtual void StopApplication ();
/**
* \brief Send a packet.
* \param config interface configuration
* \param dst destination address (default ff02::1)
* \param reschedule if true another send will be reschedule (periodic)
*/
void Send (Ptr<RadvdInterface> config, Ipv6Address dst = Ipv6Address::GetAllNodesMulticast (), bool reschedule = false);
/**
* \brief Handle received packet, especially router solicitation
* \param socket socket to read data from
*/
void HandleRead (Ptr<Socket> socket);
/**
* \brief Raw socket to receive RS.
*/
Ptr<Socket> m_recvSocket;
/**
* \brief Raw socket to send RA.
*/
SocketMap m_sendSockets;
/**
* \brief List of configuration for interface.
*/
RadvdInterfaceList m_configurations;
/**
* \brief Event ID map for unsolicited RAs.
*/
EventIdMap m_unsolicitedEventIds;
/**
* \brief Event ID map for solicited RAs.
*/
EventIdMap m_solicitedEventIds;
/**
* \brief Variable to provide jitter in advertisement interval
*/
Ptr<UniformRandomVariable> m_jitter;
};
} /* namespace ns3 */
#endif /* RADVD_H */
|