/usr/include/ns3.17/ns3/dsr-rsendbuff.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 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 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2011 Yufei Cheng
*
* 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: Yufei Cheng <yfcheng@ittc.ku.edu>
*
* James P.G. Sterbenz <jpgs@ittc.ku.edu>, director
* ResiliNets Research Group http://wiki.ittc.ku.edu/resilinets
* Information and Telecommunication Technology Center (ITTC)
* and Department of Electrical Engineering and Computer Science
* The University of Kansas Lawrence, KS USA.
*
* Work supported in part by NSF FIND (Future Internet Design) Program
* under grant CNS-0626918 (Postmodern Internet Architecture),
* NSF grant CNS-1050226 (Multilayer Network Resilience Analysis and Experimentation on GENI),
* US Department of Defense (DoD), and ITTC at The University of Kansas.
*/
#ifndef DSR_SENDBUFF_H
#define DSR_SENDBUFF_H
#include <vector>
#include "ns3/ipv4-routing-protocol.h"
#include "ns3/simulator.h"
namespace ns3 {
namespace dsr {
/**
* \ingroup dsr
* \brief DSR Send Buffer Entry
*/
class SendBuffEntry
{
public:
// / c-tor
SendBuffEntry (Ptr<const Packet> pa = 0, Ipv4Address d = Ipv4Address (),
Time exp = Simulator::Now (), uint8_t p = 0)
: m_packet (pa),
m_dst (d),
m_expire (exp + Simulator::Now ()),
m_protocol (p)
{
}
/**
* Compare send buffer entries
* \return true if equal
*/
bool operator== (SendBuffEntry const & o) const
{
return ((m_packet == o.m_packet) && (m_dst == o.m_dst) && (m_expire == o.m_expire));
}
// /\name Fields
// \{
Ptr<const Packet> GetPacket () const
{
return m_packet;
}
void SetPacket (Ptr<const Packet> p)
{
m_packet = p;
}
Ipv4Address GetDestination () const
{
return m_dst;
}
void SetDestination (Ipv4Address d)
{
m_dst = d;
}
void SetExpireTime (Time exp)
{
m_expire = exp + Simulator::Now ();
}
Time GetExpireTime () const
{
return m_expire - Simulator::Now ();
}
void SetProtocol (uint8_t p)
{
m_protocol = p;
}
uint8_t GetProtocol () const
{
return m_protocol;
}
// \}
private:
// / Data packet
Ptr<const Packet> m_packet;
// / Destination address
Ipv4Address m_dst;
// / Expire time for queue entry
Time m_expire;
// / The protocol number
uint8_t m_protocol;
};
/**
* \ingroup dsr
* \brief DSR send buffer
*/
/************************************************************************************************************************/
class SendBuffer
{
public:
// / Default c-tor
SendBuffer ()
{
}
// / Push entry in queue, if there is no entry with the same packet and destination address in queue.
bool Enqueue (SendBuffEntry & entry);
// / Return first found (the earliest) entry for given destination
bool Dequeue (Ipv4Address dst, SendBuffEntry & entry);
// / Remove all packets with destination IP address dst
void DropPacketWithDst (Ipv4Address dst);
// / Finds whether a packet with destination dst exists in the queue
bool Find (Ipv4Address dst);
// / Number of entries
uint32_t GetSize ();
// /\name Fields
// \{
uint32_t GetMaxQueueLen () const
{
return m_maxLen;
}
void SetMaxQueueLen (uint32_t len)
{
m_maxLen = len;
}
Time GetSendBufferTimeout () const
{
return m_sendBufferTimeout;
}
void SetSendBufferTimeout (Time t)
{
m_sendBufferTimeout = t;
}
// \}
std::vector<SendBuffEntry> & GetBuffer ()
{
return m_sendBuffer;
}
private:
std::vector<SendBuffEntry> m_sendBuffer; ///< The send buffer to cache unsent packet
void Purge (); ///< Remove all expired entries
void Drop (SendBuffEntry en, std::string reason); ///< Notify that packet is dropped from queue by timeout
uint32_t m_maxLen; ///< The maximum number of packets that we allow a routing protocol to buffer.
Time m_sendBufferTimeout; ///< The maximum period of time that a routing protocol is allowed to buffer a packet for, seconds.
static bool IsEqual (SendBuffEntry en, const Ipv4Address dst) ///< Check if the send buffer entry is the same or not
{
return (en.GetDestination () == dst);
}
};
/*******************************************************************************************************************************/
} // namespace dsr
} // namespace ns3
#endif /* DSR_SENDBUFF_H */
|