ipv6-extension-header.h

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2008-2009 Strasbourg University
 *
 * 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: David Gross <gdavid.devel@gmail.com>
 */

#ifndef IPV6_EXTENSION_HEADER_H
#define IPV6_EXTENSION_HEADER_H

#include <vector>
#include <list>
#include <ostream>

#include "ns3/header.h"
#include "ns3/ipv6-address.h"
#include "ipv6-option-header.h"

namespace ns3
{

class Ipv6ExtensionHeader : public Header 
{
public:
  static TypeId GetTypeId ();

  virtual TypeId GetInstanceTypeId () const;

  Ipv6ExtensionHeader ();

  virtual ~Ipv6ExtensionHeader ();

  void SetNextHeader (uint8_t nextHeader);

  uint8_t GetNextHeader () const;

  void SetLength (uint16_t length);

  uint16_t GetLength () const;

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

  virtual uint32_t GetSerializedSize () const;

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

  virtual uint32_t Deserialize (Buffer::Iterator start);

private:
  uint8_t m_nextHeader;

  uint8_t m_length;

  Buffer m_data;
};

class OptionField
{
public:
  OptionField (uint32_t optionsOffset);

  ~OptionField ();

  uint32_t GetSerializedSize () const;

  void Serialize (Buffer::Iterator start) const;

  uint32_t Deserialize (Buffer::Iterator start, uint32_t length);

  void AddOption (Ipv6OptionHeader const& option);

  uint32_t GetOptionsOffset ();

  Buffer GetOptionBuffer ();

private:

  uint32_t CalculatePad (Ipv6OptionHeader::Alignment alignment) const;

  Buffer m_optionData;

  uint32_t m_optionsOffset;
};

class Ipv6ExtensionHopByHopHeader : public Ipv6ExtensionHeader, public OptionField
{
public:
  static TypeId GetTypeId ();

  virtual TypeId GetInstanceTypeId () const;

  Ipv6ExtensionHopByHopHeader ();

  virtual ~Ipv6ExtensionHopByHopHeader ();

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

  virtual uint32_t GetSerializedSize () const;

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

  virtual uint32_t Deserialize (Buffer::Iterator start);
};

class Ipv6ExtensionDestinationHeader : public Ipv6ExtensionHeader, public OptionField
{
public:
  static TypeId GetTypeId ();

  virtual TypeId GetInstanceTypeId () const;

  Ipv6ExtensionDestinationHeader ();

  virtual ~Ipv6ExtensionDestinationHeader ();

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

  virtual uint32_t GetSerializedSize () const;

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

  virtual uint32_t Deserialize (Buffer::Iterator start);
};

class Ipv6ExtensionFragmentHeader : public Ipv6ExtensionHeader
{
public:
  static TypeId GetTypeId ();

  virtual TypeId GetInstanceTypeId () const;

  Ipv6ExtensionFragmentHeader ();

  virtual ~Ipv6ExtensionFragmentHeader ();

  void SetOffset (uint16_t offset);

  uint16_t GetOffset () const;

  void SetMoreFragment (bool moreFragment);

  bool GetMoreFragment () const;

  void SetIdentification (uint32_t identification);

  uint32_t GetIdentification () const;

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

  virtual uint32_t GetSerializedSize () const;

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

  virtual uint32_t Deserialize (Buffer::Iterator start);

private:
  uint16_t m_offset;

  uint32_t m_identification;
};

class Ipv6ExtensionRoutingHeader : public Ipv6ExtensionHeader
{
public:
  static TypeId GetTypeId ();

  virtual TypeId GetInstanceTypeId () const;

  Ipv6ExtensionRoutingHeader ();

  virtual ~Ipv6ExtensionRoutingHeader ();

  void SetTypeRouting (uint8_t typeRouting);

  uint8_t GetTypeRouting () const;

  void SetSegmentsLeft (uint8_t segmentsLeft);

  uint8_t GetSegmentsLeft () const;

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

  virtual uint32_t GetSerializedSize () const;

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

  virtual uint32_t Deserialize (Buffer::Iterator start);

private:
  uint8_t m_typeRouting;

  uint8_t m_segmentsLeft;
};

class Ipv6ExtensionLooseRoutingHeader : public Ipv6ExtensionRoutingHeader
{
public:
  static TypeId GetTypeId ();

  virtual TypeId GetInstanceTypeId () const;

  Ipv6ExtensionLooseRoutingHeader ();

  virtual ~Ipv6ExtensionLooseRoutingHeader ();

  void SetNumberAddress (uint8_t n);

  void SetRoutersAddress (std::vector<Ipv6Address> routersAddress);

  std::vector<Ipv6Address> GetRoutersAddress () const;

  void SetRouterAddress (uint8_t index, Ipv6Address addr);

  Ipv6Address GetRouterAddress (uint8_t index) const;

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

  virtual uint32_t GetSerializedSize () const;

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

  virtual uint32_t Deserialize (Buffer::Iterator start);

private:
  typedef std::vector<Ipv6Address> VectorIpv6Address_t;

  VectorIpv6Address_t m_routersAddress;
};

class Ipv6ExtensionESPHeader : public Ipv6ExtensionHeader
{
public:
  static TypeId GetTypeId ();

  virtual TypeId GetInstanceTypeId () const;

  Ipv6ExtensionESPHeader ();

  virtual ~Ipv6ExtensionESPHeader ();

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

  virtual uint32_t GetSerializedSize () const;

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

  virtual uint32_t Deserialize (Buffer::Iterator start);
};

class Ipv6ExtensionAHHeader : public Ipv6ExtensionHeader
{
public:
  static TypeId GetTypeId ();

  virtual TypeId GetInstanceTypeId () const;

  Ipv6ExtensionAHHeader ();

  virtual ~Ipv6ExtensionAHHeader ();

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

  virtual uint32_t GetSerializedSize () const;

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

  virtual uint32_t Deserialize (Buffer::Iterator start);
};

} // namespace ns3

#endif /* IPV6_EXTENSION_HEADER_H */