ipv6-header.h

Go to the documentation of this file.

/*
 * Copyright (c) 2007-2008 Louis Pasteur 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: Sebastien Vincent <vincent@clarinet.u-strasbg.fr>
 */
 
#ifndef IPV6_HEADER_H
#define IPV6_HEADER_H
 
#include "ns3/deprecated.h"
#include "ns3/header.h"
#include "ns3/ipv6-address.h"
 
namespace ns3
{
 
class Ipv6Header : public Header
{
  public:
    enum DscpType
    {
        DscpDefault = 0x00,
 
        // Prefixed with "DSCP" to avoid name clash (bug 1723)
        DSCP_CS1 = 0x08,  // octal 010
        DSCP_AF11 = 0x0A, // octal 012
        DSCP_AF12 = 0x0C, // octal 014
        DSCP_AF13 = 0x0E, // octal 016
 
        DSCP_CS2 = 0x10,  // octal 020
        DSCP_AF21 = 0x12, // octal 022
        DSCP_AF22 = 0x14, // octal 024
        DSCP_AF23 = 0x16, // octal 026
 
        DSCP_CS3 = 0x18,  // octal 030
        DSCP_AF31 = 0x1A, // octal 032
        DSCP_AF32 = 0x1C, // octal 034
        DSCP_AF33 = 0x1E, // octal 036
 
        DSCP_CS4 = 0x20,  // octal 040
        DSCP_AF41 = 0x22, // octal 042
        DSCP_AF42 = 0x24, // octal 044
        DSCP_AF43 = 0x26, // octal 046
 
        DSCP_CS5 = 0x28, // octal 050
        DSCP_EF = 0x2E,  // octal 056
 
        DSCP_CS6 = 0x30, // octal 060
        DSCP_CS7 = 0x38  // octal 070
    };
 
    enum NextHeader_e
    {
        IPV6_EXT_HOP_BY_HOP = 0,
        IPV6_IPV4 = 4,
        IPV6_TCP = 6,
        IPV6_UDP = 17,
        IPV6_IPV6 = 41,
        IPV6_EXT_ROUTING = 43,
        IPV6_EXT_FRAGMENTATION = 44,
        IPV6_EXT_CONFIDENTIALITY = 50,
        IPV6_EXT_AUTHENTIFICATION = 51,
        IPV6_ICMPV6 = 58,
        IPV6_EXT_END = 59,
        IPV6_EXT_DESTINATION = 60,
        IPV6_SCTP = 135,
        IPV6_EXT_MOBILITY = 135,
        IPV6_UDP_LITE = 136,
    };
 
    static TypeId GetTypeId();
 
    TypeId GetInstanceTypeId() const override;
 
    Ipv6Header();
 
    void SetTrafficClass(uint8_t traffic);
 
    uint8_t GetTrafficClass() const;
 
    void SetDscp(DscpType dscp);
 
    DscpType GetDscp() const;
 
    std::string DscpTypeToString(DscpType dscp) const;
 
    enum EcnType
    {
        // Prefixed with "ECN" to avoid name clash
        ECN_NotECT = 0x00,
        ECN_ECT1 = 0x01,
        ECN_ECT0 = 0x02,
        ECN_CE = 0x03
    };
 
    void SetEcn(EcnType ecn);
 
    EcnType GetEcn() const;
 
    std::string EcnTypeToString(EcnType ecn) const;
 
    void SetFlowLabel(uint32_t flow);
 
    uint32_t GetFlowLabel() const;
 
    void SetPayloadLength(uint16_t len);
 
    uint16_t GetPayloadLength() const;
 
    void SetNextHeader(uint8_t next);
 
    uint8_t GetNextHeader() const;
 
    void SetHopLimit(uint8_t limit);
 
    uint8_t GetHopLimit() const;
 
    void SetSource(Ipv6Address src);
 
    NS_DEPRECATED_3_35
    void SetSourceAddress(Ipv6Address src);
 
    Ipv6Address GetSource() const;
 
    NS_DEPRECATED_3_35
    Ipv6Address GetSourceAddress() const;
 
    void SetDestination(Ipv6Address dst);
 
    NS_DEPRECATED_3_35
    void SetDestinationAddress(Ipv6Address dst);
 
    Ipv6Address GetDestination() const;
 
    NS_DEPRECATED_3_35
    Ipv6Address GetDestinationAddress() const;
 
    void Print(std::ostream& os) const override;
 
    uint32_t GetSerializedSize() const override;
 
    void Serialize(Buffer::Iterator start) const override;
 
    uint32_t Deserialize(Buffer::Iterator start) override;
 
  private:
    uint32_t m_trafficClass : 8;
 
    uint32_t m_flowLabel : 20;
 
    uint16_t m_payloadLength;
 
    uint8_t m_nextHeader;
 
    uint8_t m_hopLimit;
 
    Ipv6Address m_sourceAddress;
 
    Ipv6Address m_destinationAddress;
};
 
} /* namespace ns3 */
 
#endif /* IPV6_HEADER_H */