ipv4-header.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2005 INRIA
 *
 * 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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 */

#ifndef IPV4_HEADER_H
#define IPV4_HEADER_H

#include "ns3/header.h"
#include "ns3/ipv4-address.h"

namespace ns3 {
class Ipv4Header : public Header 
{
public:
  Ipv4Header ();
  void EnableChecksum (void);
  void SetPayloadSize (uint16_t size);
  void SetIdentification (uint16_t identification);
  void SetTos (uint8_t tos);
  enum DscpType
    {
      DscpDefault = 0x00,

      // Prefixed with "DSCP" to avoid name clash (bug 1723)
      DSCP_CS1 = 0x20,
      DSCP_AF11 = 0x28,
      DSCP_AF12 = 0x30,
      DSCP_AF13 = 0x38,

      DSCP_CS2 = 0x40,
      DSCP_AF21 = 0x48,
      DSCP_AF22 = 0x50,
      DSCP_AF23 = 0x58,

      DSCP_CS3 = 0x60,
      DSCP_AF31 = 0x68,
      DSCP_AF32 = 0x70,
      DSCP_AF33 = 0x78,

      DSCP_CS4 = 0x80,
      DSCP_AF41 = 0x88,
      DSCP_AF42 = 0x90,
      DSCP_AF43 = 0x98,

      DSCP_CS5 = 0xA0,
      DSCP_EF = 0xB8,
      
      DSCP_CS6 = 0xC0,
      DSCP_CS7 = 0xE0
      
    };
  void SetDscp (DscpType dscp);

  enum EcnType
    {
      // Prefixed with "ECN" to avoid name clash (bug 1723)
      ECN_NotECT = 0x00,
      ECN_ECT1 = 0x01,
      ECN_ECT0 = 0x02,
      ECN_CE = 0x03
    }; 
  void SetEcn (EcnType ecn);
  void SetMoreFragments (void);
  void SetLastFragment (void);
  void SetDontFragment (void);
  void SetMayFragment (void);
  void SetFragmentOffset (uint16_t offsetBytes);
  void SetTtl (uint8_t ttl);
  void SetProtocol (uint8_t num);
  void SetSource (Ipv4Address source);
  void SetDestination (Ipv4Address destination);
  uint16_t GetPayloadSize (void) const;
  uint16_t GetIdentification (void) const;
  uint8_t GetTos (void) const;
  DscpType GetDscp (void) const;
  std::string DscpTypeToString (DscpType dscp) const;
  EcnType GetEcn (void) const;
  std::string EcnTypeToString (EcnType ecn) const;
  bool IsLastFragment (void) const;
  bool IsDontFragment (void) const;
  uint16_t GetFragmentOffset (void) const;
  uint8_t GetTtl (void) const;
  uint8_t GetProtocol (void) const;
  Ipv4Address GetSource (void) const;
  Ipv4Address GetDestination (void) const;

  bool IsChecksumOk (void) const;

  static TypeId GetTypeId (void);
  virtual TypeId GetInstanceTypeId (void) const;
  virtual void Print (std::ostream &os) const;
  virtual uint32_t GetSerializedSize (void) const;
  virtual void Serialize (Buffer::Iterator start) const;
  virtual uint32_t Deserialize (Buffer::Iterator start);
private:

  enum FlagsE {
    DONT_FRAGMENT = (1<<0),
    MORE_FRAGMENTS = (1<<1)
  };

  bool m_calcChecksum;

  uint16_t m_payloadSize;
  uint16_t m_identification;
  uint32_t m_tos : 8; //Also used as DSCP + ECN value
  uint32_t m_ttl : 8;
  uint32_t m_protocol : 8;
  uint32_t m_flags : 3;
  uint16_t m_fragmentOffset;
  Ipv4Address m_source;
  Ipv4Address m_destination;
  uint16_t m_checksum;
  bool m_goodChecksum;
  uint16_t m_headerSize;
};

} // namespace ns3


#endif /* IPV4_HEADER_H */