dsr-errorbuff.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011 Yufei Cheng
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 * Author: Yufei Cheng   <yfcheng@ittc.ku.edu>
 *
 * James P.G. Sterbenz <jpgs@ittc.ku.edu>, director
 * ResiliNets Research Group  https://resilinets.org/
 * 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_ERRORBUFF_H
#define DSR_ERRORBUFF_H
 
#include "ns3/ipv4-routing-protocol.h"
#include "ns3/simulator.h"
 
#include <vector>
 
namespace ns3
{
namespace dsr
{
/**
 * \ingroup dsr
 * \brief DSR Error Buffer Entry
 */
class DsrErrorBuffEntry
{
  public:
    /**
     * Create an DsrErrorBuffEntry with the given parameters.
     *
     * \param pa packet
     * \param d IPv4 address of the destination
     * \param s IPv4 address of the source
     * \param n IPv4 address of the next hop
     * \param exp expiration time
     * \param p protocol number
     */
    DsrErrorBuffEntry(Ptr<const Packet> pa = nullptr,
                      Ipv4Address d = Ipv4Address(),
                      Ipv4Address s = Ipv4Address(),
                      Ipv4Address n = Ipv4Address(),
                      Time exp = Simulator::Now(),
                      uint8_t p = 0)
        : m_packet(pa),
          m_dst(d),
          m_source(s),
          m_nextHop(n),
          m_expire(exp + Simulator::Now()),
          m_protocol(p)
    {
    }
 
    /**
     * Compare send buffer entries
     * \param o another DsrErrorBuffEntry
     * \return true if equal
     */
    bool operator==(const DsrErrorBuffEntry& o) const
    {
        return ((m_packet == o.m_packet) && (m_source == o.m_source) &&
                (m_nextHop == o.m_nextHop) && (m_dst == o.m_dst) && (m_expire == o.m_expire));
    }
 
    // Fields
    /**
     * Get packet from entry
     * \returns the packet
     */
    Ptr<const Packet> GetPacket() const
    {
        return m_packet;
    }
 
    /**
     * Set packet for entry
     * \param p the packet
     */
    void SetPacket(Ptr<const Packet> p)
    {
        m_packet = p;
    }
 
    /**
     * Get destination address
     * \returns the destination IPv4 address
     */
    Ipv4Address GetDestination() const
    {
        return m_dst;
    }
 
    /**
     * Set destination address
     * \param d the destination IPv4 address
     */
    void SetDestination(Ipv4Address d)
    {
        m_dst = d;
    }
 
    /**
     * Get source address
     * \returns the source IPv4 address
     */
    Ipv4Address GetSource() const
    {
        return m_source;
    }
 
    /**
     * Set source address
     * \param s the source IPv4 address
     */
    void SetSource(Ipv4Address s)
    {
        m_source = s;
    }
 
    /**
     * Get next hop
     * \returns the next hop address
     */
    Ipv4Address GetNextHop() const
    {
        return m_nextHop;
    }
 
    /**
     * Set next hop
     * \param n the next hop IPv4 address
     */
    void SetNextHop(Ipv4Address n)
    {
        m_nextHop = n;
    }
 
    /**
     * Set expire time
     * \param exp the expire time
     */
    void SetExpireTime(Time exp)
    {
        m_expire = exp + Simulator::Now();
    }
 
    /**
     * Get expire time
     * \returns the expire time
     */
    Time GetExpireTime() const
    {
        return m_expire - Simulator::Now();
    }
 
    /**
     * Set protocol number
     * \param p the protocol number
     */
    void SetProtocol(uint8_t p)
    {
        m_protocol = p;
    }
 
    /**
     * Get protocol number
     * \returns the protocol number
     */
    uint8_t GetProtocol() const
    {
        return m_protocol;
    }
 
  private:
    /// Data packet
    Ptr<const Packet> m_packet; ///< the packet
    /// Destination address
    Ipv4Address m_dst; ///< destination address
    /// Source address
    Ipv4Address m_source; ///< source address
    /// Nexthop address
    Ipv4Address m_nextHop; ///< next hop
    /// Expire time for queue entry
    Time m_expire; ///< expiration time
    /// The protocol number
    uint8_t m_protocol;
};
 
/**
 * \ingroup dsr
 * \brief DSR error buffer
 */
/************************************************************************************************************************/
class DsrErrorBuffer
{
  public:
    /**
     * Default constructor
     */
    DsrErrorBuffer()
    {
    }
 
    /**
     * Push entry in queue, if there is no entry with the same packet and destination address in
     * queue.
     *
     * \param entry error buffer entry
     * \return true if entry added
     */
    bool Enqueue(DsrErrorBuffEntry& entry);
    /**
     * Return first found (the earliest) entry for given destination
     * \param [in] dst The destination to look for
     * \param [out] entry The entry
     * \return true if an entry is found
     */
    bool Dequeue(Ipv4Address dst, DsrErrorBuffEntry& entry);
    /**
     * Remove all packets with the error link
     * \param source The source
     * \param nextHop The next hop
     */
    void DropPacketForErrLink(Ipv4Address source, Ipv4Address nextHop);
    /**
     * Finds whether a packet with destination dst exists in the queue
     * \param dst The destination
     * \return true if a packet is found.
     */
    bool Find(Ipv4Address dst);
    /**
     * Returns the number of entries in the queue.
     * \return the number of entries in the queue.
     */
    uint32_t GetSize();
 
    // Fields
    /**
     * Get maximum queue length
     * \returns the maximum queue length
     */
    uint32_t GetMaxQueueLen() const
    {
        return m_maxLen;
    }
 
    /**
     * Set maximum queue length
     * \param len the maximum queue length
     */
    void SetMaxQueueLen(uint32_t len)
    {
        m_maxLen = len;
    }
 
    /**
     * Get error buffer timeout
     * \returns the error buffer timeout
     */
    Time GetErrorBufferTimeout() const
    {
        return m_errorBufferTimeout;
    }
 
    /**
     * Set error buffer timeout
     * \param t the error buffer timeout
     */
    void SetErrorBufferTimeout(Time t)
    {
        m_errorBufferTimeout = t;
    }
 
    /**
     * Get error buffer entry
     * \returns the DSR error buffer
     */
    std::vector<DsrErrorBuffEntry>& GetBuffer()
    {
        return m_errorBuffer;
    }
 
  private:
    /// The send buffer to cache unsent packet
    std::vector<DsrErrorBuffEntry> m_errorBuffer;
    /// Remove all expired entries
    void Purge();
    /**
     * Notify that packet is dropped from queue by timeout
     * \param en Error Buffer Entry
     * \param reason Drop reason.
     */
    ///
    void Drop(DsrErrorBuffEntry en, std::string reason);
    /**
     * Notify that packet is dropped from queue by link error
     * \param en Error Buffer Entry
     * \param reason Drop reason.
     */
    void DropLink(DsrErrorBuffEntry en, std::string reason);
    /// The maximum number of packets that we allow a routing protocol to buffer.
    uint32_t m_maxLen;
    /// The maximum period of time that a routing protocol is allowed to buffer a packet for,
    /// seconds.
    Time m_errorBufferTimeout;
};
 
/*******************************************************************************************************************************/
} // namespace dsr
} // namespace ns3
 
#endif /* DSR_ERRORBUFF_H */