/usr/include/ns3.27/ns3/arp-l3-protocol.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 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2006 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 ARP_L3_PROTOCOL_H
#define ARP_L3_PROTOCOL_H
#include <list>
#include "ns3/ipv4-header.h"
#include "ns3/net-device.h"
#include "ns3/address.h"
#include "ns3/ptr.h"
#include "ns3/traced-callback.h"
#include "ns3/random-variable-stream.h"
namespace ns3 {
class ArpCache;
class NetDevice;
class Node;
class Packet;
class Ipv4Interface;
/**
* \ingroup ipv4
* \defgroup arp ARP protocol.
*
* The ARP protocol and its associated tables are responsible
* for the IPv4 - MAC address translation.
* Each NetDevice has its own ARP table.
*/
/**
* \ingroup arp
* \brief An implementation of the ARP protocol.
*/
class ArpL3Protocol : public Object
{
public:
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId (void);
static const uint16_t PROT_NUMBER; //!< ARP protocol number (0x0806)
ArpL3Protocol ();
virtual ~ArpL3Protocol ();
/**
* \brief Set the node the ARP L3 protocol is associated with
* \param node the node
*/
void SetNode (Ptr<Node> node);
/**
* \brief Create an ARP cache for the device/interface
* \param device the NetDevice
* \param interface the Ipv4Interface
* \returns a smart pointer to the ARP cache
*/
Ptr<ArpCache> CreateCache (Ptr<NetDevice> device, Ptr<Ipv4Interface> interface);
/**
* \brief Receive a packet
* \param device the source NetDevice
* \param p the packet
* \param protocol the protocol
* \param from the source address
* \param to the destination address
* \param packetType type of packet (i.e., unicast, multicast, etc.)
*/
void Receive (Ptr<NetDevice> device, Ptr<const Packet> p, uint16_t protocol, const Address &from, const Address &to,
NetDevice::PacketType packetType);
/**
* \brief Perform an ARP lookup
* \param p the packet
* \param ipHeader the IPv4 header
* \param destination destination IP address
* \param device outgoing device
* \param cache ARP cache
* \param hardwareDestination filled with the destination MAC address (if the entry exists)
* \return true if there is a matching ARP Entry
*/
bool Lookup (Ptr<Packet> p, const Ipv4Header & ipHeader, Ipv4Address destination,
Ptr<NetDevice> device,
Ptr<ArpCache> cache,
Address *hardwareDestination);
/**
* 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:
virtual void DoDispose (void);
/*
* This function will notify other components connected to the node that a new stack member is now connected
* This will be used to notify Layer 3 protocol of layer 4 protocol stack to connect them together.
*/
virtual void NotifyNewAggregate ();
private:
typedef std::list<Ptr<ArpCache> > CacheList; //!< container of the ARP caches
/**
* \brief Copy constructor
*
* Defined and unimplemented to avoid misuse
* \param o
*/
ArpL3Protocol (const ArpL3Protocol &o);
/**
* \brief Copy constructor
*
* Defined and unimplemented to avoid misuse
* \param o
* \returns
*/
ArpL3Protocol &operator = (const ArpL3Protocol &o);
/**
* \brief Finds the cache associated with a NetDevice
* \param device the NetDevice
* \returns the ARP cache, or null if no cache is found
*/
Ptr<ArpCache> FindCache (Ptr<NetDevice> device);
/**
* \brief Send an ARP request to an host
* \param cache the ARP cache to use
* \param to the destination IP
*/
void SendArpRequest (Ptr<const ArpCache>cache, Ipv4Address to);
/**
* \brief Send an ARP reply to an host
* \param cache the ARP cache to use
* \param myIp the source IP address
* \param toIp the destination IP
* \param toMac the destination MAC address
*/
void SendArpReply (Ptr<const ArpCache> cache, Ipv4Address myIp, Ipv4Address toIp, Address toMac);
CacheList m_cacheList; //!< ARP cache container
Ptr<Node> m_node; //!< node the ARP L3 protocol is associated with
TracedCallback<Ptr<const Packet> > m_dropTrace; //!< trace for packets dropped by ARP
Ptr<RandomVariableStream> m_requestJitter; //!< jitter to de-sync ARP requests
};
} // namespace ns3
#endif /* ARP_L3_PROTOCOL_H */
|