A Discrete-Event Network Simulator
API
ipv6-header.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2007-2008 Louis Pasteur University
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Sebastien Vincent <vincent@clarinet.u-strasbg.fr>
19  */
20 
21 #ifndef IPV6_HEADER_H
22 #define IPV6_HEADER_H
23 
24 #include "ns3/header.h"
25 #include "ns3/ipv6-address.h"
26 
27 namespace ns3 {
28 
34 class Ipv6Header : public Header
35 {
36 public:
45  enum DscpType
46  {
47  DscpDefault = 0x00,
48 
49  // Prefixed with "DSCP" to avoid name clash (bug 1723)
50  DSCP_CS1 = 0x08, // octal 010
51  DSCP_AF11 = 0x0A, // octal 012
52  DSCP_AF12 = 0x0C, // octal 014
53  DSCP_AF13 = 0x0E, // octal 016
54 
55  DSCP_CS2 = 0x10, // octal 020
56  DSCP_AF21 = 0x12, // octal 022
57  DSCP_AF22 = 0x14, // octal 024
58  DSCP_AF23 = 0x16, // octal 026
59 
60  DSCP_CS3 = 0x18, // octal 030
61  DSCP_AF31 = 0x1A, // octal 032
62  DSCP_AF32 = 0x1C, // octal 034
63  DSCP_AF33 = 0x1E, // octal 036
64 
65  DSCP_CS4 = 0x20, // octal 040
66  DSCP_AF41 = 0x22, // octal 042
67  DSCP_AF42 = 0x24, // octal 044
68  DSCP_AF43 = 0x26, // octal 046
69 
70  DSCP_CS5 = 0x28, // octal 050
71  DSCP_EF = 0x2E, // octal 056
72 
73  DSCP_CS6 = 0x30, // octal 060
74  DSCP_CS7 = 0x38 // octal 070
75 
76  };
77 
83  {
85  IPV6_IPV4 = 4,
86  IPV6_TCP = 6,
87  IPV6_UDP = 17,
88  IPV6_IPV6 = 41,
96  IPV6_SCTP = 135,
99  };
100 
105  static TypeId GetTypeId (void);
106 
111  virtual TypeId GetInstanceTypeId (void) const;
112 
116  Ipv6Header (void);
117 
122  void SetTrafficClass (uint8_t traffic);
123 
128  uint8_t GetTrafficClass (void) const;
129 
134  void SetDscp (DscpType dscp);
135 
139  DscpType GetDscp (void) const;
140 
145  std::string DscpTypeToString (DscpType dscp) const;
146 
151  enum EcnType
152  {
153  // Prefixed with "ECN" to avoid name clash
154  ECN_NotECT = 0x00,
155  ECN_ECT1 = 0x01,
156  ECN_ECT0 = 0x02,
157  ECN_CE = 0x03
158  };
159 
164  void SetEcn (EcnType ecn);
165 
169  EcnType GetEcn (void) const;
170 
175  std::string EcnTypeToString (EcnType ecn) const;
176 
181  void SetFlowLabel (uint32_t flow);
182 
187  uint32_t GetFlowLabel (void) const;
188 
193  void SetPayloadLength (uint16_t len);
194 
199  uint16_t GetPayloadLength (void) const;
200 
205  void SetNextHeader (uint8_t next);
206 
211  uint8_t GetNextHeader (void) const;
212 
217  void SetHopLimit (uint8_t limit);
218 
223  uint8_t GetHopLimit (void) const;
224 
229  void SetSourceAddress (Ipv6Address src);
230 
235  Ipv6Address GetSourceAddress (void) const;
236 
242 
247  Ipv6Address GetDestinationAddress (void) const;
248 
254  virtual void Print (std::ostream& os) const;
255 
260  virtual uint32_t GetSerializedSize (void) const;
261 
266  virtual void Serialize (Buffer::Iterator start) const;
267 
273  virtual uint32_t Deserialize (Buffer::Iterator start);
274 
275 private:
279  uint32_t m_trafficClass : 8;
280 
285  uint32_t m_flowLabel : 20;
286 
290  uint16_t m_payloadLength;
291 
295  uint8_t m_nextHeader;
296 
300  uint8_t m_hopLimit;
301 
306 
311 };
312 
313 } /* namespace ns3 */
314 
315 #endif /* IPV6_HEADER_H */
316 
Protocol header serialization and deserialization.
Definition: header.h:42
uint8_t GetTrafficClass(void) const
Get the "Traffic class" field.
Definition: ipv6-header.cc:50
virtual uint32_t GetSerializedSize(void) const
Get the serialized size of the packet.
Definition: ipv6-header.cc:143
uint8_t GetNextHeader(void) const
Get the next header.
Definition: ipv6-header.cc:80
void SetPayloadLength(uint16_t len)
Set the "Payload length" field.
Definition: ipv6-header.cc:65
uint32_t m_flowLabel
The flow label.
Definition: ipv6-header.h:285
Packet header for IPv6.
Definition: ipv6-header.h:34
def start()
Definition: core.py:1806
uint32_t m_trafficClass
The traffic class.
Definition: ipv6-header.h:279
void SetNextHeader(uint8_t next)
Set the "Next header" field.
Definition: ipv6-header.cc:75
DscpType
DiffServ Code Points Code Points defined in Assured Forwarding (AF) RFC 2597 Expedited Forwarding (EF...
Definition: ipv6-header.h:45
Ipv6Address m_sourceAddress
The source address.
Definition: ipv6-header.h:305
virtual TypeId GetInstanceTypeId(void) const
Return the instance type identifier.
Definition: ipv6-header.cc:125
NextHeader_e
IPv6 next-header value.
Definition: ipv6-header.h:82
iterator in a Buffer instance
Definition: buffer.h:98
DscpType GetDscp(void) const
Definition: ipv6-header.cc:202
Ipv6Address m_destinationAddress
The destination address.
Definition: ipv6-header.h:310
uint32_t GetFlowLabel(void) const
Get the "Flow label" field.
Definition: ipv6-header.cc:60
virtual uint32_t Deserialize(Buffer::Iterator start)
Deserialize the packet.
Definition: ipv6-header.cc:164
uint8_t GetHopLimit(void) const
Get the "Hop limit" field (TTL).
Definition: ipv6-header.cc:90
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void SetEcn(EcnType ecn)
Set ECN field bits.
Definition: ipv6-header.cc:195
virtual void Print(std::ostream &os) const
Print some information about the packet.
Definition: ipv6-header.cc:130
uint16_t GetPayloadLength(void) const
Get the "Payload length" field.
Definition: ipv6-header.cc:70
std::string DscpTypeToString(DscpType dscp) const
Definition: ipv6-header.cc:209
Ipv6Header(void)
Constructor.
Definition: ipv6-header.cc:34
static TypeId GetTypeId(void)
Get the type identifier.
Definition: ipv6-header.cc:115
void SetSourceAddress(Ipv6Address src)
Set the "Source address" field.
Definition: ipv6-header.cc:95
std::string EcnTypeToString(EcnType ecn) const
Definition: ipv6-header.cc:269
Describes an IPv6 address.
Definition: ipv6-address.h:49
virtual void Serialize(Buffer::Iterator start) const
Serialize the packet.
Definition: ipv6-header.cc:148
void SetHopLimit(uint8_t limit)
Set the "Hop limit" field (TTL).
Definition: ipv6-header.cc:85
EcnType
ECN field bits.
Definition: ipv6-header.h:151
Ipv6Address GetSourceAddress(void) const
Get the "Source address" field.
Definition: ipv6-header.cc:100
void SetFlowLabel(uint32_t flow)
Set the "Flow label" field.
Definition: ipv6-header.cc:55
EcnType GetEcn(void) const
Definition: ipv6-header.cc:262
uint16_t m_payloadLength
The payload length.
Definition: ipv6-header.h:290
void SetTrafficClass(uint8_t traffic)
Set the "Traffic class" field.
Definition: ipv6-header.cc:45
uint8_t m_hopLimit
The Hop limit value.
Definition: ipv6-header.h:300
uint8_t m_nextHeader
The Next header number.
Definition: ipv6-header.h:295
a unique identifier for an interface.
Definition: type-id.h:58
void SetDestinationAddress(Ipv6Address dst)
Set the "Destination address" field.
Definition: ipv6-header.cc:105
Ipv6Address GetDestinationAddress(void) const
Get the "Destination address" field.
Definition: ipv6-header.cc:110
void SetDscp(DscpType dscp)
Set DSCP Field.
Definition: ipv6-header.cc:188