A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
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
249
bool
m_calcChecksum
;
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
;
258
Ipv4Address
m_source
;
259
Ipv4Address
m_destination
;
260
uint16_t
m_checksum
;
261
bool
m_goodChecksum
;
262
uint16_t
m_headerSize
;
263
};
264
265
}
// namespace ns3
266
267
268
#endif
/* IPV4_HEADER_H */
ns3::Buffer::Iterator
iterator in a Buffer instance
Definition:
buffer.h:99
ns3::Header
Protocol header serialization and deserialization.
Definition:
header.h:43
ns3::Header::Deserialize
virtual uint32_t Deserialize(Buffer::Iterator start)=0
Deserialize the object from a buffer iterator.
ns3::Ipv4Address
Ipv4 addresses are stored in host order in this class.
Definition:
ipv4-address.h:41
ns3::Ipv4Header
Packet header for IPv4.
Definition:
ipv4-header.h:34
ns3::Ipv4Header::GetDscp
DscpType GetDscp(void) const
Definition:
ipv4-header.cc:105
ns3::Ipv4Header::SetMoreFragments
void SetMoreFragments(void)
This packet is not the last packet of a fragmented ipv4 packet.
Definition:
ipv4-header.cc:200
ns3::Ipv4Header::m_source
Ipv4Address m_source
source address
Definition:
ipv4-header.h:258
ns3::Ipv4Header::SetDestination
void SetDestination(Ipv4Address destination)
Definition:
ipv4-header.cc:298
ns3::Ipv4Header::GetTypeId
static TypeId GetTypeId(void)
Get the type ID.
Definition:
ipv4-header.cc:319
ns3::Ipv4Header::m_fragmentOffset
uint16_t m_fragmentOffset
Fragment offset.
Definition:
ipv4-header.h:257
ns3::Ipv4Header::EcnTypeToString
std::string EcnTypeToString(EcnType ecn) const
Definition:
ipv4-header.cc:175
ns3::Ipv4Header::SetLastFragment
void SetLastFragment(void)
This packet is the last packet of a fragmented ipv4 packet.
Definition:
ipv4-header.cc:206
ns3::Ipv4Header::FlagsE
FlagsE
flags related to IP fragmentation
Definition:
ipv4-header.h:244
ns3::Ipv4Header::MORE_FRAGMENTS
@ MORE_FRAGMENTS
Definition:
ipv4-header.h:246
ns3::Ipv4Header::DONT_FRAGMENT
@ DONT_FRAGMENT
Definition:
ipv4-header.h:245
ns3::Ipv4Header::GetSerializedSize
virtual uint32_t GetSerializedSize(void) const
Definition:
ipv4-header.cc:375
ns3::Ipv4Header::m_ttl
uint32_t m_ttl
TTL.
Definition:
ipv4-header.h:254
ns3::Ipv4Header::m_protocol
uint32_t m_protocol
Protocol.
Definition:
ipv4-header.h:255
ns3::Ipv4Header::SetPayloadSize
void SetPayloadSize(uint16_t size)
Definition:
ipv4-header.cc:56
ns3::Ipv4Header::Print
virtual void Print(std::ostream &os) const
Definition:
ipv4-header.cc:335
ns3::Ipv4Header::m_identification
uint16_t m_identification
identification
Definition:
ipv4-header.h:252
ns3::Ipv4Header::GetIdentification
uint16_t GetIdentification(void) const
Definition:
ipv4-header.cc:69
ns3::Ipv4Header::GetFragmentOffset
uint16_t GetFragmentOffset(void) const
Definition:
ipv4-header.cc:246
ns3::Ipv4Header::GetTos
uint8_t GetTos(void) const
Definition:
ipv4-header.cc:194
ns3::Ipv4Header::GetSource
Ipv4Address GetSource(void) const
Definition:
ipv4-header.cc:291
ns3::Ipv4Header::m_payloadSize
uint16_t m_payloadSize
payload size
Definition:
ipv4-header.h:251
ns3::Ipv4Header::SetTtl
void SetTtl(uint8_t ttl)
Definition:
ipv4-header.cc:259
ns3::Ipv4Header::IsDontFragment
bool IsDontFragment(void) const
Definition:
ipv4-header.cc:231
ns3::Ipv4Header::m_tos
uint32_t m_tos
TOS, also used as DSCP + ECN value.
Definition:
ipv4-header.h:253
ns3::Ipv4Header::m_goodChecksum
bool m_goodChecksum
true if checksum is correct
Definition:
ipv4-header.h:261
ns3::Ipv4Header::SetMayFragment
void SetMayFragment(void)
If you need to fragment this packet, you can do it.
Definition:
ipv4-header.cc:225
ns3::Ipv4Header::SetDscp
void SetDscp(DscpType dscp)
Set DSCP Field.
Definition:
ipv4-header.cc:89
ns3::Ipv4Header::SetDontFragment
void SetDontFragment(void)
Don't fragment this packet: if you need to anyway, drop it.
Definition:
ipv4-header.cc:219
ns3::Ipv4Header::GetDestination
Ipv4Address GetDestination(void) const
Definition:
ipv4-header.cc:304
ns3::Ipv4Header::m_destination
Ipv4Address m_destination
destination address
Definition:
ipv4-header.h:259
ns3::Ipv4Header::GetEcn
EcnType GetEcn(void) const
Definition:
ipv4-header.cc:167
ns3::Ipv4Header::EnableChecksum
void EnableChecksum(void)
Enable checksum calculation for this header.
Definition:
ipv4-header.cc:49
ns3::Ipv4Header::EcnType
EcnType
ECN Type defined in RFC 3168
Definition:
ipv4-header.h:113
ns3::Ipv4Header::ECN_ECT0
@ ECN_ECT0
Definition:
ipv4-header.h:117
ns3::Ipv4Header::ECN_NotECT
@ ECN_NotECT
Definition:
ipv4-header.h:115
ns3::Ipv4Header::ECN_ECT1
@ ECN_ECT1
Definition:
ipv4-header.h:116
ns3::Ipv4Header::ECN_CE
@ ECN_CE
Definition:
ipv4-header.h:118
ns3::Ipv4Header::m_checksum
uint16_t m_checksum
checksum
Definition:
ipv4-header.h:260
ns3::Ipv4Header::m_headerSize
uint16_t m_headerSize
IP header size.
Definition:
ipv4-header.h:262
ns3::Ipv4Header::SetEcn
void SetEcn(EcnType ecn)
Set ECN Field.
Definition:
ipv4-header.cc:97
ns3::Ipv4Header::DscpType
DscpType
DiffServ codepoints.
Definition:
ipv4-header.h:71
ns3::Ipv4Header::DSCP_AF23
@ DSCP_AF23
Definition:
ipv4-header.h:83
ns3::Ipv4Header::DSCP_CS2
@ DSCP_CS2
Definition:
ipv4-header.h:80
ns3::Ipv4Header::DscpDefault
@ DscpDefault
Definition:
ipv4-header.h:72
ns3::Ipv4Header::DSCP_AF31
@ DSCP_AF31
Definition:
ipv4-header.h:86
ns3::Ipv4Header::DSCP_AF32
@ DSCP_AF32
Definition:
ipv4-header.h:87
ns3::Ipv4Header::DSCP_AF13
@ DSCP_AF13
Definition:
ipv4-header.h:78
ns3::Ipv4Header::DSCP_AF22
@ DSCP_AF22
Definition:
ipv4-header.h:82
ns3::Ipv4Header::DSCP_AF43
@ DSCP_AF43
Definition:
ipv4-header.h:93
ns3::Ipv4Header::DSCP_AF11
@ DSCP_AF11
Definition:
ipv4-header.h:76
ns3::Ipv4Header::DSCP_CS3
@ DSCP_CS3
Definition:
ipv4-header.h:85
ns3::Ipv4Header::DSCP_AF42
@ DSCP_AF42
Definition:
ipv4-header.h:92
ns3::Ipv4Header::DSCP_AF21
@ DSCP_AF21
Definition:
ipv4-header.h:81
ns3::Ipv4Header::DSCP_AF33
@ DSCP_AF33
Definition:
ipv4-header.h:88
ns3::Ipv4Header::DSCP_AF12
@ DSCP_AF12
Definition:
ipv4-header.h:77
ns3::Ipv4Header::DSCP_CS5
@ DSCP_CS5
Definition:
ipv4-header.h:95
ns3::Ipv4Header::DSCP_EF
@ DSCP_EF
Definition:
ipv4-header.h:96
ns3::Ipv4Header::DSCP_CS4
@ DSCP_CS4
Definition:
ipv4-header.h:90
ns3::Ipv4Header::DSCP_CS7
@ DSCP_CS7
Definition:
ipv4-header.h:99
ns3::Ipv4Header::DSCP_CS6
@ DSCP_CS6
Definition:
ipv4-header.h:98
ns3::Ipv4Header::DSCP_CS1
@ DSCP_CS1
Definition:
ipv4-header.h:75
ns3::Ipv4Header::DSCP_AF41
@ DSCP_AF41
Definition:
ipv4-header.h:91
ns3::Ipv4Header::GetProtocol
uint8_t GetProtocol(void) const
Definition:
ipv4-header.cc:272
ns3::Ipv4Header::DscpTypeToString
std::string DscpTypeToString(DscpType dscp) const
Definition:
ipv4-header.cc:113
ns3::Ipv4Header::m_flags
uint32_t m_flags
flags
Definition:
ipv4-header.h:256
ns3::Ipv4Header::GetPayloadSize
uint16_t GetPayloadSize(void) const
Definition:
ipv4-header.cc:62
ns3::Ipv4Header::SetProtocol
void SetProtocol(uint8_t num)
Definition:
ipv4-header.cc:278
ns3::Ipv4Header::SetFragmentOffset
void SetFragmentOffset(uint16_t offsetBytes)
The offset is measured in bytes for the packet start.
Definition:
ipv4-header.cc:238
ns3::Ipv4Header::SetIdentification
void SetIdentification(uint16_t identification)
Definition:
ipv4-header.cc:75
ns3::Ipv4Header::IsChecksumOk
bool IsChecksumOk(void) const
Definition:
ipv4-header.cc:312
ns3::Ipv4Header::IsLastFragment
bool IsLastFragment(void) const
Definition:
ipv4-header.cc:212
ns3::Ipv4Header::GetInstanceTypeId
virtual TypeId GetInstanceTypeId(void) const
Get the most derived TypeId for this Object.
Definition:
ipv4-header.cc:329
ns3::Ipv4Header::Serialize
virtual void Serialize(Buffer::Iterator start) const
Definition:
ipv4-header.cc:383
ns3::Ipv4Header::SetTos
void SetTos(uint8_t tos)
Definition:
ipv4-header.cc:82
ns3::Ipv4Header::SetSource
void SetSource(Ipv4Address source)
Definition:
ipv4-header.cc:285
ns3::Ipv4Header::Ipv4Header
Ipv4Header()
Construct a null IPv4 header.
Definition:
ipv4-header.cc:33
ns3::Ipv4Header::m_calcChecksum
bool m_calcChecksum
true if the checksum must be calculated
Definition:
ipv4-header.h:249
ns3::Ipv4Header::GetTtl
uint8_t GetTtl(void) const
Definition:
ipv4-header.cc:265
ns3::TypeId
a unique identifier for an interface.
Definition:
type-id.h:59
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
visualizer.core.start
def start()
Definition:
core.py:1853
src
internet
model
ipv4-header.h
Generated on Tue Feb 6 2024 19:21:19 for ns-3 by
1.9.1