/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */

/*

 * Copyright (c) 2009 IITP RAS

 *

 * 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

 *

 * Based on 

 *      NS-2 AODV model developed by the CMU/MONARCH group and optimized and

 *      tuned by Samir Das and Mahesh Marina, University of Cincinnati;

 * 

 *      AODV-UU implementation by Erik Nordström of Uppsala University

 *      http://core.it.uu.se/core/index.php/AODV-UU

 *

 * Authors: Elena Borovkova <borovkovaes@iitp.ru>

 *          Pavel Boyko <boyko@iitp.ru>

 */

#ifndef __aodv_rtable_h__

#define __aodv_rtable_h__

#include <cassert>

#include <map>

#include <sys/types.h>

#include "ns3/ipv4.h"

#include "ns3/ipv4-route.h"

#include "ns3/ipv4-address.h"

#include "ns3/nstime.h"

#include "ns3/net-device.h"

namespace ns3 {

namespace aodv {

#define INFINITY2       0xff

#define DELETE_PERIOD   10 // seconds. TODO: remove defines

enum RouteFlags

{

  RTF_DOWN = 0,

  RTF_UP = 1,

  RTF_IN_REPAIR = 2

};

/**

 * \ingroup aodv

 * \brief Route Table Entry

 */

{

public:

      Ipv4Address nextHop = Ipv4Address(), Time lifetime = Seconds(0));

  ///\name Precursors management

  //\{

  /**

   * Insert precursor in precursor list if it doesn't yet exist in the list

   * \param id precursor address

   * \return true on success

   */

  /**

   * Lookup precursor by address

   * \param id precursor address

   * \return true on success

   */

  /**

   * \brief Delete precursor

   * \param id precursor address

   * \return true on success

   */

  /// Delete all precursors

  /**

   * \return true if precursor list empty

   */

  //\}

  /// Return last valid hop count

  /// Mark entry as "down" (i.e. disable it)

  void Down ();

  ///\name Fields

  //\{

  Ipv4Address GetDestination() const { return m_ipv4Route->GetDestination(); }

  Ptr<Ipv4Route> GetRoute() const { return  m_ipv4Route; }

  void SetRoute(Ptr<Ipv4Route> r) { m_ipv4Route = r; }

  void SetNextHop (Ipv4Address nextHop) { m_ipv4Route->SetGateway(nextHop); }

  Ipv4Address GetNextHop () const { return m_ipv4Route->GetGateway(); }

  void SetOutputDevice(Ptr<NetDevice> dev) { m_ipv4Route->SetOutputDevice(dev); }

  Ptr<NetDevice> GetOutputDevice() const { return m_ipv4Route->GetOutputDevice(); }

  //\}

  /**

   * \brief Compare destination address

   * \return true if equal

   */

  bool operator==(Ipv4Address const  dst) const

  {

    return (m_ipv4Route->GetDestination() == dst);

  }

  void Print(std::ostream & os) const;

private:

  /// Valid Destination Sequence Number flag

  /// Hop Count (number of hops needed to reach destination)

  /// Last valid hop count

  /**

  * \brief Expiration or deletion time of the route

  *	Lifetime field in the routing table plays dual role --

  *	for an active route it is the expiration time, and for an invalid route

  *	it is the deletion time.

  */

  /** Ip route, include

  *   - destination address

  *   - source address

  *   - next hop address (gateway)

  *   - output device

  */

  Ptr<Ipv4Route> m_ipv4Route;

  /// Routing flags: down, up or in repair

  /// List of precursors

  /// When I can send another request

  /// Number of route requests

  // TODO review and delete

  double rt_disc_latency[MAX_HISTORY];

  char hist_indx;

};

/**

 * \ingroup aodv

 * The Routing Table

 */

{

public:

  /**

   * Add routing table entry if it doesn't yet exist in routing table

   * \param r routing table entry

   * \return true in success

   */

  /**

   * Delete routing table entry

   * \param dst destination address

   * \return true on success

   */

  /**

   * Lookup routing table entry

   * \param dst destination address

   * \param rt entry with destination address dst, if exists

   * \return true on success

   */

  /// Update routing table

  /// Set routing table entry flags

  void SetEntryState (Ipv4Address dst, uint8_t state /*TODO use enum*/);

  /// Print routing table

  void Print(std::ostream &os) const;

private:

};

}}

#endif /* _aodv__rtable_h__ */