A Discrete-Event Network Simulator
API
udp-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 UDP_HEADER_H
22#define UDP_HEADER_H
23
24#include <stdint.h>
25#include <string>
26#include "ns3/header.h"
27#include "ns3/ipv4-address.h"
28#include "ns3/ipv6-address.h"
29
30namespace ns3 {
39class UdpHeader : public Header
40{
41public:
42
48 UdpHeader ();
49 ~UdpHeader ();
50
54 void EnableChecksums (void);
58 void SetDestinationPort (uint16_t port);
62 void SetSourcePort (uint16_t port);
66 uint16_t GetSourcePort (void) const;
70 uint16_t GetDestinationPort (void) const;
71
83 void InitializeChecksum (Address source,
84 Address destination,
85 uint8_t protocol);
86
99 Ipv4Address destination,
100 uint8_t protocol);
101
113 void InitializeChecksum (Ipv6Address source,
114 Ipv6Address destination,
115 uint8_t protocol);
116
121 static TypeId GetTypeId (void);
122 virtual TypeId GetInstanceTypeId (void) const;
123 virtual void Print (std::ostream &os) const;
124 virtual uint32_t GetSerializedSize (void) const;
125 virtual void Serialize (Buffer::Iterator start) const;
127
132 bool IsChecksumOk (void) const;
133
151 void ForceChecksum (uint16_t checksum);
152
161 void ForcePayloadSize (uint16_t payloadSize);
162
167 uint16_t GetChecksum ();
168
169private:
175 uint16_t CalculateHeaderChecksum (uint16_t size) const;
176 uint16_t m_sourcePort;
178 uint16_t m_payloadSize;
179
182 uint8_t m_protocol;
183 uint16_t m_checksum;
186};
187
188} // namespace ns3
189
190#endif /* UDP_HEADER */
a polymophic address class
Definition: address.h:91
iterator in a Buffer instance
Definition: buffer.h:99
Protocol header serialization and deserialization.
Definition: header.h:43
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:41
Describes an IPv6 address.
Definition: ipv6-address.h:50
a unique identifier for an interface.
Definition: type-id.h:59
Packet header for UDP packets.
Definition: udp-header.h:40
virtual void Serialize(Buffer::Iterator start) const
Definition: udp-header.cc:184
void EnableChecksums(void)
Enable checksum calculation for UDP.
Definition: udp-header.cc:49
Address m_destination
Destination IP address.
Definition: udp-header.h:181
uint16_t CalculateHeaderChecksum(uint16_t size) const
Calculate the header checksum.
Definition: udp-header.cc:102
virtual uint32_t GetSerializedSize(void) const
Definition: udp-header.cc:178
uint8_t m_protocol
Protocol number.
Definition: udp-header.h:182
uint16_t GetSourcePort(void) const
Definition: udp-header.cc:65
UdpHeader()
Constructor.
Definition: udp-header.cc:32
uint16_t m_destinationPort
Destination port.
Definition: udp-header.h:177
static TypeId GetTypeId(void)
Get the type ID.
Definition: udp-header.cc:154
Address m_source
Source IP address.
Definition: udp-header.h:180
virtual uint32_t Deserialize(Buffer::Iterator start)
Definition: udp-header.cc:220
uint16_t m_payloadSize
Payload size.
Definition: udp-header.h:178
void ForceChecksum(uint16_t checksum)
Force the UDP checksum to a given value.
Definition: udp-header.cc:142
bool IsChecksumOk(void) const
Is the UDP checksum correct ?
Definition: udp-header.cc:136
uint16_t m_sourcePort
Source port.
Definition: udp-header.h:176
bool m_calcChecksum
Flag to calculate checksum.
Definition: udp-header.h:184
void ForcePayloadSize(uint16_t payloadSize)
Force the UDP payload length to a given value.
Definition: udp-header.cc:148
uint16_t GetChecksum()
Return the checksum (only known after a Deserialize)
Definition: udp-header.cc:241
virtual void Print(std::ostream &os) const
Definition: udp-header.cc:169
uint16_t GetDestinationPort(void) const
Definition: udp-header.cc:70
uint16_t m_checksum
Forced Checksum value.
Definition: udp-header.h:183
void InitializeChecksum(Address source, Address destination, uint8_t protocol)
Definition: udp-header.cc:75
void SetSourcePort(uint16_t port)
Definition: udp-header.cc:60
bool m_goodChecksum
Flag to indicate that checksum is correct.
Definition: udp-header.h:185
void SetDestinationPort(uint16_t port)
Definition: udp-header.cc:55
virtual TypeId GetInstanceTypeId(void) const
Get the most derived TypeId for this Object.
Definition: udp-header.cc:164
uint16_t port
Definition: dsdv-manet.cc:45
Every class exported by the ns3 library is enclosed in the ns3 namespace.
def start()
Definition: core.py:1852