/* -*- 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_OPTION_HEADER_H

#define DSR_OPTION_HEADER_H

#include <ostream>

#include <algorithm>

#include "ns3/header.h"

#include "ns3/ipv4-address.h"

#include "ns3/simulator.h"

namespace ns3 {

class Time;

namespace dsr {

/**

 * \class DsrOptionHeader

 * \brief Header for Dsr Options.

 */

class DsrOptionHeader : public Header

{

public:

  /**

   * \struct Alignment

   * \brief represents the alignment requirements of an option header

   */

  struct Alignment

  {

    uint8_t factor;   /**< Factor */

    uint8_t offset;   /**< Offset */

  };

  /**

   * \brief Get the type identificator.

   * \return type identificator

   */

  static TypeId GetTypeId ();

  /**

   * \brief Get the instance type ID.

   * \return instance type ID

   */

  virtual TypeId GetInstanceTypeId () const;

  /**

   * \brief Constructor.

   */

  DsrOptionHeader ();

  /**

   * \brief Destructor.

   */

  virtual ~DsrOptionHeader ();

  /**

   * \brief Set the type of the option.

   * \param type the type of the option

   */

  void SetType (uint8_t type);

  /**

   * \brief Get the type of the option.

   * \return the type of the option

   */

  uint8_t GetType () const;

  /**

   * \brief Set the option length.

   * \param length the option length

   */

  void SetLength (uint8_t length);

  /**

   * \brief Get the option length.

   * \return the option length

   */

  uint8_t GetLength () const;

  /**

   * \brief Print some informations about the packet.

   * \param os output stream

   * \return info about this packet

   */

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

  /**

   * \brief Get the serialized size of the packet.

   * \return size

   */

  virtual uint32_t GetSerializedSize () const;

  /**

   * \brief Serialize the packet.

   * \param start Buffer iterator

   */

  virtual void Serialize (Buffer::Iterator start) const;

  /**

   * \brief Deserialize the packet.

   * \param start Buffer iterator

   * \return size of the packet

   */

  virtual uint32_t Deserialize (Buffer::Iterator start);

  /**

   * \brief Get the Alignment requirement of this option header

   * \return The required alignment

   *

   * Subclasses should only implement this method, if special alignment is

   * required. Default is no alignment (1n+0).

   */

  virtual Alignment GetAlignment () const;

private:

  /**

   * \brief The type of the option.

   */

  uint8_t m_type;

  /**

   * \brief The option length.

   */

  uint8_t m_length;

  /**

   * \brief The anonymous data of this option

   */

  Buffer m_data;

};

/**

 * \class DsrOptionPad1Header

 * \brief Header of Dsr Option Pad1

 */

class DsrOptionPad1Header : public DsrOptionHeader

{

public:

  /**

   * \brief Get the type identificator.

   * \return type identificator

   */

  static TypeId GetTypeId ();

  /**

   * \brief Get the instance type ID.

   * \return instance type ID

   */

  virtual TypeId GetInstanceTypeId () const;

  /**

   * \brief Constructor.

   */

  DsrOptionPad1Header ();

  /**

   * \brief Destructor.

   */

  virtual ~DsrOptionPad1Header ();

  /**

   * \brief Print some informations about the packet.

   * \param os output stream

   * \return info about this packet

   */

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

  /**

   * \brief Get the serialized size of the packet.

   * \return size

   */

  virtual uint32_t GetSerializedSize () const;

  /**

   * \brief Serialize the packet.

   * \param start Buffer iterator

   */

  virtual void Serialize (Buffer::Iterator start) const;

  /**

   * \brief Deserialize the packet.

   * \param start Buffer iterator

   * \return size of the packet

   */

  virtual uint32_t Deserialize (Buffer::Iterator start);

};

/**

 * \class DsrOptionPadnHeader

 * \brief Header of Dsr Option Padn

 */

class DsrOptionPadnHeader : public DsrOptionHeader

{

public:

  /**

   * \brief Get the type identificator.

   * \return type identificator

   */

  static TypeId GetTypeId ();

  /**

   * \brief Get the instance type ID.

   * \return instance type ID

   */

  virtual TypeId GetInstanceTypeId () const;

  /**

   * \brief Constructor.

   * \param pad Number of bytes to pad (>=2)

   */

  DsrOptionPadnHeader (uint32_t pad = 2);

  /**

   * \brief Destructor.

   */

  virtual ~DsrOptionPadnHeader ();

  /**

   * \brief Print some informations about the packet.

   * \param os output stream

   * \return info about this packet

   */

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

  /**

   * \brief Get the serialized size of the packet.

   * \return size

   */

  virtual uint32_t GetSerializedSize () const;

  /**

   * \brief Serialize the packet.

   * \param start Buffer iterator

   */

  virtual void Serialize (Buffer::Iterator start) const;

  /**

   * \brief Deserialize the packet.

   * \param start Buffer iterator

   * \return size of the packet

   */

  virtual uint32_t Deserialize (Buffer::Iterator start);

};

/**

 * \class DsrOptionRouteRequestHeader

 * \brief Header of Dsr Option Route Request

 */

/**

* \ingroup dsr

* \brief   Route Request (RREQ) Message Format

  \verbatim

   |      0        |      1        |      2        |      3        |

   0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7

   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   |  Option Type |  Opt Data Len |         Identification         |

   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   |                         Target Address                        |

   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   |                            Address[1]                         |

   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   |                            Address[2]                         |

   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   |                               ...                             |

   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   |                            Address[n]                         |

   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

  \endverbatim

*/

class DsrOptionRreqHeader : public DsrOptionHeader

{

public:

  /**

   * \brief Get the type identificator.

   * \return type identificator

   */

  static TypeId GetTypeId ();

  /**

   * \brief Get the instance type ID.

   * \return instance type ID

   */

  virtual TypeId GetInstanceTypeId () const;

  /**

   * \brief Constructor.

   */

  DsrOptionRreqHeader ();

  /**

   * \brief Destructor.

   */

  virtual ~DsrOptionRreqHeader ();

  /**

   * \brief Set the number of ipv4 address.

   * \param n the number of ipv4 address

   */

  void SetNumberAddress (uint8_t n);

  /**

   * \brief Get the target ipv4 address.

   * \return target the target packet

   */

  Ipv4Address GetTarget ();

  /**

   * \brief Set the target ipv4 address.

   * \param target the target packet

   */

  void SetTarget (Ipv4Address target);

  /**

   * \brief Set the vector of ipv4 address

   * \param ipv4Address the vector of ipv4 address

   */

  void SetNodesAddress (std::vector<Ipv4Address> ipv4Address);

  /**

   * \brief Get the vector of ipv4 address

   * \return the vector of ipv4 address

   */

  std::vector<Ipv4Address> GetNodesAddresses () const;

  /**

   * \brief Get the number of nodes

   * \return the number of nodes

   */

  uint32_t GetNodesNumber () const;

  /**

   * \brief Add one node address

   * \param ipv4 The ip address to add

   */

  void AddNodeAddress (Ipv4Address ipv4);

  /**

   * \brief Set a Node IPv4 Address.

   * \param index the index of the IPv4 Address

   * \param addr the new IPv4 Address

   */

  void SetNodeAddress (uint8_t index, Ipv4Address addr);

  /**

   * \brief Get a Node IPv4 Address.

   * \param index the index of the IPv4 Address

   * \return the router IPv4 Address

   */

  Ipv4Address GetNodeAddress (uint8_t index) const;

  /**

   * \brief Set the request id number.

   * \param identification the identification number

   */

  void SetId (uint16_t identification);

  /**

   * \brief Set the request id number.

   * \return request id number

   */

  uint16_t GetId () const;

  /**

   * \brief Print some informations about the packet.

   * \param os output stream

   * \return info about this packet

   */

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

  /**

   * \brief Get the serialized size of the packet.

   * \return size

   */

  virtual uint32_t GetSerializedSize () const;

  /**

   * \brief Serialize the packet.

   * \param start Buffer iterator

   */

  virtual void Serialize (Buffer::Iterator start) const;

  /**

   * \brief Deserialize the packet.

   * \param start Buffer iterator

   * \return size of the packet

   */

  virtual uint32_t Deserialize (Buffer::Iterator start);

  /**

   * \brief Get the Alignment requirement of this option header

   * \return The required alignment

   */

  virtual Alignment GetAlignment () const;

private:

  /**

   * \brief Identifier of the packet.

   */

  uint16_t m_identification;

  /*

   * Ipv4 address of target node

   */

  Ipv4Address m_target;

  /*

   * Ipv4 address to write when desearizing the packet

   */

  Ipv4Address m_address;

  /**

   * \brief A vector of IPv4 Address.

   */

  typedef std::vector<Ipv4Address> VectorIpv4Address_t;

  /**

   * \brief The vector of Nodes' IPv4 Address.

   */

  VectorIpv4Address_t m_ipv4Address;

};

/**

 * \class DsrOptionRrepHeader

 * \brief Header of Dsr Option Route Reply

 */

/**

* \ingroup dsr

* \brief Route Reply (RREP) Message Format

  \verbatim

   |      0        |      1        |      2        |      3        |

   0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7

                  -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                  |  Option Type  |  Opt Data Len |L|   Reserved   |

   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   |                            Address[1]                         |

   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   |                            Address[2]                         |

   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   |                               ...                             |

   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   |                            Address[n]                         |

   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

  \endverbatim

*/

// The Route Reply header modified for ns-3 implementation

/**

* \ingroup dsr

* \brief Route Reply (RREP) Message Format

  \verbatim

   |      0        |      1        |      2        |      3        |

   0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7

   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   |  Option Type  |  Opt Data Len |L|   Reserved   |   Reserved   |

   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   |                            Address[1]                         |

   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   |                            Address[2]                         |

   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   |                               ...                             |

   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

   |                            Address[n]                         |

   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

  \endverbatim

*/

class DsrOptionRrepHeader : public DsrOptionHeader

{

public:

  /**

   * \brief Get the type identificator.

   * \return type identificator

   */

  static TypeId GetTypeId ();

  /**

   * \brief Get the instance type ID.

   * \return instance type ID

   */

  virtual TypeId GetInstanceTypeId () const;

  /**

   * \brief Constructor.

   */

  DsrOptionRrepHeader ();

  /**

   * \brief Destructor.

   */

  virtual ~DsrOptionRrepHeader ();

  /**

   * \brief Set the number of ipv4 address.

   * \param n the number of ipv4 address

   */

  void SetNumberAddress (uint8_t n);

  /**

   * \brief Set the vector of ipv4 address

   * \param ipv4Address the vector of ipv4 address

   */

  void SetNodesAddress (std::vector<Ipv4Address> ipv4Address);

  /**

   * \brief Get the vector of ipv4 address

   * \return the vector of ipv4 address

   */

  std::vector<Ipv4Address> GetNodesAddress () const;

  /*

   * \brief Get the target node Ip address

   * \return the target address

   */

  Ipv4Address GetTargetAddress (std::vector<Ipv4Address> ipv4Address) const;

  /**

   * \brief Set a Node IPv4 Address.

   * \param index the index of the IPv4 Address

   * \param addr the new IPv4 Address

   */

  void SetNodeAddress (uint8_t index, Ipv4Address addr);

  /**

   * \brief Get a Node IPv4 Address.

   * \param index the index of the IPv4 Address

   * \return the router IPv4 Address

   */

  Ipv4Address GetNodeAddress (uint8_t index) const;

  /**

   * \brief Print some informations about the packet.

   * \param os output stream

   * \return info about this packet

   */

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

  /**

   * \brief Get the serialized size of the packet.

   * \return size

   */

  virtual uint32_t GetSerializedSize () const;

  /**

   * \brief Serialize the packet.

   * \param start Buffer iterator

   */

  virtual void Serialize (Buffer::Iterator start) const;

  /**

   * \brief Deserialize the packet.

   * \param start Buffer iterator

   * \return size of the packet

   */

  virtual uint32_t Deserialize (Buffer::Iterator start);

  /**

   * \brief Get the Alignment requirement of this option header

   * \return The required alignment

   */

  virtual Alignment GetAlignment () const;

private: