A Discrete-Event Network Simulator
API
ipv4-header.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2005 INRIA
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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 
21 #ifndef IPV4_HEADER_H
22 #define IPV4_HEADER_H
23 
24 #include "ns3/header.h"
25 #include "ns3/ipv4-address.h"
26 
27 namespace ns3 {
33 class Ipv4Header : public Header
34 {
35 public:
39  Ipv4Header ();
43  void EnableChecksum (void);
47  void SetPayloadSize (uint16_t size);
53  void SetIdentification (uint16_t identification);
57  void SetTos (uint8_t tos);
58 public:
70  enum DscpType
71  {
72  DscpDefault = 0x00,
73 
74  // Prefixed with "DSCP" to avoid name clash (bug 1723)
75  DSCP_CS1 = 0x08, // octal 010
76  DSCP_AF11 = 0x0A, // octal 012
77  DSCP_AF12 = 0x0C, // octal 014
78  DSCP_AF13 = 0x0E, // octal 016
79 
80  DSCP_CS2 = 0x10, // octal 020
81  DSCP_AF21 = 0x12, // octal 022
82  DSCP_AF22 = 0x14, // octal 024
83  DSCP_AF23 = 0x16, // octal 026
84 
85  DSCP_CS3 = 0x18, // octal 030
86  DSCP_AF31 = 0x1A, // octal 032
87  DSCP_AF32 = 0x1C, // octal 034
88  DSCP_AF33 = 0x1E, // octal 036
89 
90  DSCP_CS4 = 0x20, // octal 040
91  DSCP_AF41 = 0x22, // octal 042
92  DSCP_AF42 = 0x24, // octal 044
93  DSCP_AF43 = 0x26, // octal 046
94 
95  DSCP_CS5 = 0x28, // octal 050
96  DSCP_EF = 0x2E, // octal 056
97 
98  DSCP_CS6 = 0x30, // octal 060
99  DSCP_CS7 = 0x38 // octal 070
100 
101  };
106  void SetDscp (DscpType dscp);
107 
112  enum EcnType
113  {
114  // Prefixed with "ECN" to avoid name clash (bug 1723)
115  ECN_NotECT = 0x00,
116  ECN_ECT1 = 0x01,
117  ECN_ECT0 = 0x02,
118  ECN_CE = 0x03
119  };
124  void SetEcn (EcnType ecn);
128  void SetMoreFragments (void);
132  void SetLastFragment (void);
136  void SetDontFragment (void);
140  void SetMayFragment (void);
147  void SetFragmentOffset (uint16_t offsetBytes);
151  void SetTtl (uint8_t ttl);
155  void SetProtocol (uint8_t num);
159  void SetSource (Ipv4Address source);
163  void SetDestination (Ipv4Address destination);
167  uint16_t GetPayloadSize (void) const;
171  uint16_t GetIdentification (void) const;
175  uint8_t GetTos (void) const;
179  DscpType GetDscp (void) const;
184  std::string DscpTypeToString (DscpType dscp) const;
188  EcnType GetEcn (void) const;
193  std::string EcnTypeToString (EcnType ecn) const;
197  bool IsLastFragment (void) const;
201  bool IsDontFragment (void) const;
205  uint16_t GetFragmentOffset (void) const;
209  uint8_t GetTtl (void) const;
213  uint8_t GetProtocol (void) const;
217  Ipv4Address GetSource (void) const;
221  Ipv4Address GetDestination (void) const;
222 
229  bool IsChecksumOk (void) const;
230 
235  static TypeId GetTypeId (void);
236  virtual TypeId GetInstanceTypeId (void) const;
237  virtual void Print (std::ostream &os) const;
238  virtual uint32_t GetSerializedSize (void) const;
239  virtual void Serialize (Buffer::Iterator start) const;
240  virtual uint32_t Deserialize (Buffer::Iterator start);
241 private:
242 
244  enum FlagsE {
245  DONT_FRAGMENT = (1<<0),
246  MORE_FRAGMENTS = (1<<1)
247  };
248 
250 
251  uint16_t m_payloadSize;
252  uint16_t m_identification;
253  uint32_t m_tos : 8;
254  uint32_t m_ttl : 8;
255  uint32_t m_protocol : 8;
256  uint32_t m_flags : 3;
257  uint16_t m_fragmentOffset;
260  uint16_t m_checksum;
262  uint16_t m_headerSize;
263 };
264 
265 } // namespace ns3
266 
267 
268 #endif /* IPV4_HEADER_H */
Protocol header serialization and deserialization.
Definition: header.h:42
void SetSource(Ipv4Address source)
Definition: ipv4-header.cc:285
void SetPayloadSize(uint16_t size)
Definition: ipv4-header.cc:56
std::string DscpTypeToString(DscpType dscp) const
Definition: ipv4-header.cc:113
uint32_t m_ttl
TTL.
Definition: ipv4-header.h:254
void SetDestination(Ipv4Address destination)
Definition: ipv4-header.cc:298
uint32_t m_flags
flags
Definition: ipv4-header.h:256
uint16_t m_identification
identification
Definition: ipv4-header.h:252
DscpType
DiffServ codepoints.
Definition: ipv4-header.h:70
Ipv4Address m_destination
destination address
Definition: ipv4-header.h:259
def start()
Definition: core.py:1855
virtual TypeId GetInstanceTypeId(void) const
Get the most derived TypeId for this Object.
Definition: ipv4-header.cc:329
Ipv4Address GetSource(void) const
Definition: ipv4-header.cc:291
virtual void Serialize(Buffer::Iterator start) const
Definition: ipv4-header.cc:383
uint8_t GetTos(void) const
Definition: ipv4-header.cc:194
uint16_t m_headerSize
IP header size.
Definition: ipv4-header.h:262
void SetFragmentOffset(uint16_t offsetBytes)
The offset is measured in bytes for the packet start.
Definition: ipv4-header.cc:238
bool IsLastFragment(void) const
Definition: ipv4-header.cc:212
void SetProtocol(uint8_t num)
Definition: ipv4-header.cc:278
uint32_t m_tos
TOS, also used as DSCP + ECN value.
Definition: ipv4-header.h:253
void SetDontFragment(void)
Don&#39;t fragment this packet: if you need to anyway, drop it.
Definition: ipv4-header.cc:219
iterator in a Buffer instance
Definition: buffer.h:98
static TypeId GetTypeId(void)
Get the type ID.
Definition: ipv4-header.cc:319
uint8_t GetProtocol(void) const
Definition: ipv4-header.cc:272
Packet header for IPv4.
Definition: ipv4-header.h:33
void SetLastFragment(void)
This packet is the last packet of a fragmented ipv4 packet.
Definition: ipv4-header.cc:206
bool m_goodChecksum
true if checksum is correct
Definition: ipv4-header.h:261
std::string EcnTypeToString(EcnType ecn) const
Definition: ipv4-header.cc:175
Ipv4Header()
Construct a null IPv4 header.
Definition: ipv4-header.cc:33
void EnableChecksum(void)
Enable checksum calculation for this header.
Definition: ipv4-header.cc:49
void SetDscp(DscpType dscp)
Set DSCP Field.
Definition: ipv4-header.cc:89
virtual uint32_t GetSerializedSize(void) const
Definition: ipv4-header.cc:375
void SetIdentification(uint16_t identification)
Definition: ipv4-header.cc:75
void SetMayFragment(void)
If you need to fragment this packet, you can do it.
Definition: ipv4-header.cc:225
DscpType GetDscp(void) const
Definition: ipv4-header.cc:105
uint16_t m_fragmentOffset
Fragment offset.
Definition: ipv4-header.h:257
uint16_t GetFragmentOffset(void) const
Definition: ipv4-header.cc:246
bool IsDontFragment(void) const
Definition: ipv4-header.cc:231
Every class exported by the ns3 library is enclosed in the ns3 namespace.
uint16_t m_checksum
checksum
Definition: ipv4-header.h:260
void SetMoreFragments(void)
This packet is not the last packet of a fragmented ipv4 packet.
Definition: ipv4-header.cc:200
void SetTos(uint8_t tos)
Definition: ipv4-header.cc:82
Ipv4Address m_source
source address
Definition: ipv4-header.h:258
uint8_t GetTtl(void) const
Definition: ipv4-header.cc:265
Ipv4Address GetDestination(void) const
Definition: ipv4-header.cc:304
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:40
FlagsE
flags related to IP fragmentation
Definition: ipv4-header.h:244
uint32_t m_protocol
Protocol.
Definition: ipv4-header.h:255
void SetEcn(EcnType ecn)
Set ECN Field.
Definition: ipv4-header.cc:97
void SetTtl(uint8_t ttl)
Definition: ipv4-header.cc:259
bool IsChecksumOk(void) const
Definition: ipv4-header.cc:312
uint16_t GetPayloadSize(void) const
Definition: ipv4-header.cc:62
bool m_calcChecksum
true if the checksum must be calculated
Definition: ipv4-header.h:249
uint16_t m_payloadSize
payload size
Definition: ipv4-header.h:251
uint16_t GetIdentification(void) const
Definition: ipv4-header.cc:69
a unique identifier for an interface.
Definition: type-id.h:58
EcnType GetEcn(void) const
Definition: ipv4-header.cc:167
EcnType
ECN Type defined in RFC 3168
Definition: ipv4-header.h:112
virtual uint32_t Deserialize(Buffer::Iterator start)
Definition: ipv4-header.cc:423
virtual void Print(std::ostream &os) const
Definition: ipv4-header.cc:335