Packet header for UDP packets. More...

#include "udp-header.h"

Inheritance diagram for ns3::UdpHeader:

Collaboration diagram for ns3::UdpHeader:

Public Member Functions
uint32_t	Deserialize (Buffer::Iterator start) override

void	EnableChecksums ()
	Enable checksum calculation for UDP. More...

void	ForceChecksum (uint16_t checksum)
	Force the UDP checksum to a given value. More...

void	ForcePayloadSize (uint16_t payloadSize)
	Force the UDP payload length to a given value. More...

uint16_t	GetChecksum () const
	Return the checksum (only known after a Deserialize) More...

uint16_t	GetDestinationPort () const

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object. More...

uint32_t	GetSerializedSize () const override

uint16_t	GetSourcePort () const

void	InitializeChecksum (Address source, Address destination, uint8_t protocol)

void	InitializeChecksum (Ipv4Address source, Ipv4Address destination, uint8_t protocol)

void	InitializeChecksum (Ipv6Address source, Ipv6Address destination, uint8_t protocol)

bool	IsChecksumOk () const
	Is the UDP checksum correct ? More...

void	Print (std::ostream &os) const override

void	Serialize (Buffer::Iterator start) const override

void	SetDestinationPort (uint16_t port)

void	SetSourcePort (uint16_t port)

Public Member Functions inherited from ns3::Header
	~Header () override

virtual uint32_t	Deserialize (Buffer::Iterator start)=0
	Deserialize the object from a buffer iterator. More...

virtual uint32_t	Deserialize (Buffer::Iterator start, Buffer::Iterator end)
	Deserialize the object from a buffer iterator. More...

Public Member Functions inherited from ns3::Chunk
virtual uint32_t	Deserialize (Buffer::Iterator start, Buffer::Iterator end)
	Deserialize the object from a buffer iterator. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Header
static TypeId	GetTypeId ()
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Chunk
static TypeId	GetTypeId ()
	Get the type ID. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID. More...

Private Member Functions
uint16_t	CalculateHeaderChecksum (uint16_t size) const
	Calculate the header checksum. More...

Private Attributes
bool	m_calcChecksum {false}
	Flag to calculate checksum. More...

uint16_t	m_checksum {0}
	Forced Checksum value. More...

Address	m_destination
	Destination IP address. More...

uint16_t	m_destinationPort {0xfffd}
	Destination port. More...

uint16_t	m_forcedPayloadSize {0}
	Payload size (forced) More...

bool	m_goodChecksum {true}
	Flag to indicate that checksum is correct. More...

uint16_t	m_payloadSize {0}
	Payload size. More...

uint8_t	m_protocol {17}
	Protocol number. More...

Address	m_source
	Source IP address. More...

uint16_t	m_sourcePort {0xfffd}
	Source port. More...

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

Packet header for UDP packets.

This class has fields corresponding to those in a network UDP header (port numbers, payload size, checksum) as well as methods for serialization to and deserialization from a byte buffer.

Definition at line 40 of file udp-header.h.

Member Function Documentation

◆ CalculateHeaderChecksum()

uint16_t ns3::UdpHeader::CalculateHeaderChecksum ( uint16_t size ) const

private

Calculate the header checksum.

Parameters

size	packet size

Returns: the checksum

Definition at line 84 of file udp-header.cc.

References ns3::Buffer::AddAtStart(), ns3::Buffer::Begin(), ns3::Buffer::Iterator::CalculateIpChecksum(), ns3::Ipv4Address::IsMatchingType(), ns3::Ipv6Address::IsMatchingType(), m_destination, m_protocol, m_source, ns3::Address::MAX_SIZE, ns3::WriteTo(), ns3::Buffer::Iterator::WriteU16(), and ns3::Buffer::Iterator::WriteU8().

Referenced by Deserialize(), and Serialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Deserialize()

uint32_t ns3::UdpHeader::Deserialize ( Buffer::Iterator start )

overridevirtual

Parameters

start an iterator which points to where the header should read from.

Returns: the number of bytes read.

This method is used by Packet::RemoveHeader to re-create a header from the byte buffer of a packet. The data read is expected to match bit-for-bit the representation of this header in real networks.

Note that data is not actually removed from the buffer to which the iterator points. Both Packet::RemoveHeader() and Packet::PeekHeader() call Deserialize(), but only the RemoveHeader() has additional statements to remove the header bytes from the underlying buffer and associated metadata.

Implements ns3::Header.

Definition at line 202 of file udp-header.cc.

References CalculateHeaderChecksum(), ns3::Buffer::Iterator::CalculateIpChecksum(), GetSerializedSize(), m_calcChecksum, m_checksum, m_destinationPort, m_goodChecksum, m_payloadSize, m_sourcePort, ns3::Buffer::Iterator::ReadNtohU16(), ns3::Buffer::Iterator::ReadU16(), and two-ray-to-three-gpp-ch-calibration::start.

Here is the call graph for this function:

◆ EnableChecksums()

void ns3::UdpHeader::EnableChecksums ( )

Enable checksum calculation for UDP.

Definition at line 30 of file udp-header.cc.

References m_calcChecksum.

Referenced by ns3::SixLowPanNetDevice::DecompressLowPanUdpNhc(), ns3::UdpL4Protocol::Receive(), and ns3::UdpL4Protocol::Send().

Here is the caller graph for this function:

◆ ForceChecksum()

void ns3::UdpHeader::ForceChecksum ( uint16_t checksum )

Force the UDP checksum to a given value.

This might be useful for test purposes or to restore the UDP checksum when the UDP header has been compressed (e.g., in 6LoWPAN). Note that, normally, the header checksum is calculated on the fly when the packet is serialized.

When this option is used, the UDP checksum is written in the header, regardless of the global ChecksumEnabled option.

Note: The checksum value must be a big endian number.

Parameters

checksum the checksum to use (big endian).

Definition at line 124 of file udp-header.cc.

References m_checksum.

Referenced by ns3::SixLowPanNetDevice::DecompressLowPanUdpNhc().

Here is the caller graph for this function:

◆ ForcePayloadSize()

void ns3::UdpHeader::ForcePayloadSize ( uint16_t payloadSize )

Force the UDP payload length to a given value.

This might be useful when forging a packet for test purposes.

Parameters

payloadSize the payload length to use.

Definition at line 130 of file udp-header.cc.

References m_forcedPayloadSize.

◆ GetChecksum()

uint16_t ns3::UdpHeader::GetChecksum ( ) const

Return the checksum (only known after a Deserialize)

Returns: The checksum for this UdpHeader

Definition at line 223 of file udp-header.cc.

References m_checksum.

Referenced by ns3::SixLowPanNetDevice::CompressLowPanUdpNhc().

Here is the caller graph for this function:

◆ GetDestinationPort()

uint16_t ns3::UdpHeader::GetDestinationPort ( ) const

Returns: the destination port for this UdpHeader

Definition at line 54 of file udp-header.cc.

References m_destinationPort.

Referenced by ns3::OpenFlowSwitchNetDevice::BufferFromPacket(), LteIpv6RoutingTestCase::Checker(), ns3::IpcsClassifier::Classify(), ns3::EpcTftClassifier::Classify(), ns3::SixLowPanNetDevice::CompressLowPanUdpNhc(), ns3::Ipv4QueueDiscItem::Hash(), ns3::Ipv6QueueDiscItem::Hash(), ns3::UdpL4Protocol::Receive(), and ns3::aodv::RoutingProtocol::RouteInput().

Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::UdpHeader::GetInstanceTypeId ( ) const

overridevirtual

Get the most derived TypeId for this Object.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Returns: The TypeId associated to the most-derived type of this instance.

Implements ns3::ObjectBase.

Definition at line 146 of file udp-header.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetSerializedSize()

uint32_t ns3::UdpHeader::GetSerializedSize ( ) const

overridevirtual

Returns: the expected size of the header.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. This method should return the number of bytes which are needed to store the full header data by Serialize.

Implements ns3::Header.

Definition at line 159 of file udp-header.cc.

Referenced by Deserialize(), ns3::Rip::DoSendRouteUpdate(), ns3::RipNg::DoSendRouteUpdate(), ns3::Rip::HandleRequests(), ns3::RipNg::HandleRequests(), and Print().

Here is the caller graph for this function:

◆ GetSourcePort()

uint16_t ns3::UdpHeader::GetSourcePort ( ) const

Returns: The source port for this UdpHeader

Definition at line 48 of file udp-header.cc.

References m_sourcePort.

Referenced by ns3::OpenFlowSwitchNetDevice::BufferFromPacket(), LteIpv6RoutingTestCase::Checker(), ns3::IpcsClassifier::Classify(), ns3::EpcTftClassifier::Classify(), ns3::SixLowPanNetDevice::CompressLowPanUdpNhc(), ns3::Ipv4QueueDiscItem::Hash(), ns3::Ipv6QueueDiscItem::Hash(), and ns3::UdpL4Protocol::Receive().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::UdpHeader::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 136 of file udp-header.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InitializeChecksum() [1/3]

void ns3::UdpHeader::InitializeChecksum	(	Address	source,
		Address	destination,
		uint8_t	protocol
	)

Parameters

source	the ip source to use in the underlying ip packet.
destination	the ip destination to use in the underlying ip packet.
protocol	the protocol number to use in the underlying ip packet.

If you want to use udp checksums, you should call this method prior to adding the header to a packet.

Definition at line 60 of file udp-header.cc.

References m_destination, m_protocol, and m_source.

Referenced by ns3::SixLowPanNetDevice::DecompressLowPanUdpNhc(), ns3::UdpL4Protocol::Receive(), and ns3::UdpL4Protocol::Send().

Here is the caller graph for this function:

◆ InitializeChecksum() [2/3]

void ns3::UdpHeader::InitializeChecksum	(	Ipv4Address	source,
		Ipv4Address	destination,
		uint8_t	protocol
	)

Parameters

source	the ip source to use in the underlying ip packet.
destination	the ip destination to use in the underlying ip packet.
protocol	the protocol number to use in the underlying ip packet.

If you want to use udp checksums, you should call this method prior to adding the header to a packet.

Definition at line 68 of file udp-header.cc.

References m_destination, m_protocol, and m_source.

◆ InitializeChecksum() [3/3]

void ns3::UdpHeader::InitializeChecksum	(	Ipv6Address	source,
		Ipv6Address	destination,
		uint8_t	protocol
	)

Parameters

source	the ip source to use in the underlying ip packet.
destination	the ip destination to use in the underlying ip packet.
protocol	the protocol number to use in the underlying ip packet.

If you want to use udp checksums, you should call this method prior to adding the header to a packet.

Definition at line 76 of file udp-header.cc.

References m_destination, m_protocol, and m_source.

◆ IsChecksumOk()

bool ns3::UdpHeader::IsChecksumOk ( ) const

Is the UDP checksum correct ?

Returns: true if the checksum is correct, false otherwise.

Definition at line 118 of file udp-header.cc.

References m_goodChecksum.

Referenced by ns3::SixLowPanNetDevice::CompressLowPanUdpNhc(), ns3::SixLowPanNetDevice::DecompressLowPanUdpNhc(), and ns3::UdpL4Protocol::Receive().

Here is the caller graph for this function:

◆ Print()

void ns3::UdpHeader::Print ( std::ostream & os ) const

overridevirtual

Parameters

os output stream This method is used by Packet::Print to print the content of a header as ascii data to a c++ output stream. Although the header is free to format its output as it wishes, it is recommended to follow a few rules to integrate with the packet pretty printer: start with flags, small field values located between a pair of parens. Values should be separated by whitespace. Follow the parens with the important fields, separated by whitespace. i.e.: (field1 val1 field2 val2 field3 val3) field4 val4 field5 val5

Implements ns3::Header.

Definition at line 152 of file udp-header.cc.

References GetSerializedSize(), m_destinationPort, m_payloadSize, and m_sourcePort.

Here is the call graph for this function:

◆ Serialize()

void ns3::UdpHeader::Serialize ( Buffer::Iterator start ) const

overridevirtual

Parameters

start an iterator which points to where the header should be written.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. The data written is expected to match bit-for-bit the representation of this header in a real network.

Implements ns3::Header.

Definition at line 165 of file udp-header.cc.

References CalculateHeaderChecksum(), ns3::Buffer::Iterator::CalculateIpChecksum(), m_calcChecksum, m_checksum, m_destinationPort, m_forcedPayloadSize, m_sourcePort, ns3::Buffer::Iterator::Next(), two-ray-to-three-gpp-ch-calibration::start, ns3::Buffer::Iterator::WriteHtonU16(), and ns3::Buffer::Iterator::WriteU16().

Here is the call graph for this function:

◆ SetDestinationPort()

void ns3::UdpHeader::SetDestinationPort ( uint16_t port )

Parameters

port	the destination port for this UdpHeader

Definition at line 36 of file udp-header.cc.

References m_destinationPort, and port.

Referenced by EpcTftClassifierTestCase::EpcTftClassifierTestCase(), ns3::SixLowPanNetDevice::DecompressLowPanUdpNhc(), FqCobaltQueueDiscUDPFlowsSeparation::DoRun(), FqCoDelQueueDiscUDPFlowsSeparation::DoRun(), FqPieQueueDiscUDPFlowsSeparation::DoRun(), and ns3::UdpL4Protocol::Send().

Here is the caller graph for this function:

◆ SetSourcePort()

void ns3::UdpHeader::SetSourcePort ( uint16_t port )

Parameters

port	The source port for this UdpHeader

Definition at line 42 of file udp-header.cc.

References m_sourcePort, and port.

Referenced by EpcTftClassifierTestCase::EpcTftClassifierTestCase(), ns3::SixLowPanNetDevice::DecompressLowPanUdpNhc(), FqCobaltQueueDiscUDPFlowsSeparation::DoRun(), FqCoDelQueueDiscUDPFlowsSeparation::DoRun(), FqPieQueueDiscUDPFlowsSeparation::DoRun(), and ns3::UdpL4Protocol::Send().

Here is the caller graph for this function:

Member Data Documentation

◆ m_calcChecksum

bool ns3::UdpHeader::m_calcChecksum {false}

private

Flag to calculate checksum.

Definition at line 175 of file udp-header.h.

Referenced by Deserialize(), EnableChecksums(), and Serialize().

◆ m_checksum

uint16_t ns3::UdpHeader::m_checksum {0}

private

Forced Checksum value.

Definition at line 174 of file udp-header.h.

Referenced by Deserialize(), ForceChecksum(), GetChecksum(), and Serialize().

◆ m_destination

Address ns3::UdpHeader::m_destination

private

Destination IP address.

Definition at line 172 of file udp-header.h.

Referenced by CalculateHeaderChecksum(), and InitializeChecksum().

◆ m_destinationPort

uint16_t ns3::UdpHeader::m_destinationPort {0xfffd}

private

Destination port.

Definition at line 167 of file udp-header.h.

Referenced by Deserialize(), GetDestinationPort(), Print(), Serialize(), and SetDestinationPort().

◆ m_forcedPayloadSize

uint16_t ns3::UdpHeader::m_forcedPayloadSize {0}

private

Payload size (forced)

Definition at line 169 of file udp-header.h.

Referenced by ForcePayloadSize(), and Serialize().

◆ m_goodChecksum

bool ns3::UdpHeader::m_goodChecksum {true}

private

Flag to indicate that checksum is correct.

Definition at line 176 of file udp-header.h.

Referenced by Deserialize(), and IsChecksumOk().

◆ m_payloadSize

uint16_t ns3::UdpHeader::m_payloadSize {0}

private

Payload size.

Definition at line 168 of file udp-header.h.

Referenced by Deserialize(), and Print().

◆ m_protocol

uint8_t ns3::UdpHeader::m_protocol {17}

private

Protocol number.

Definition at line 173 of file udp-header.h.

Referenced by CalculateHeaderChecksum(), and InitializeChecksum().

◆ m_source

Address ns3::UdpHeader::m_source

private

Source IP address.

Definition at line 171 of file udp-header.h.

Referenced by CalculateHeaderChecksum(), and InitializeChecksum().

◆ m_sourcePort

uint16_t ns3::UdpHeader::m_sourcePort {0xfffd}

private

Source port.

Definition at line 166 of file udp-header.h.

Referenced by Deserialize(), GetSourcePort(), Print(), Serialize(), and SetSourcePort().

The documentation for this class was generated from the following files:

src/internet/model/udp-header.h
src/internet/model/udp-header.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CalculateHeaderChecksum()

◆ Deserialize()

◆ EnableChecksums()

◆ ForceChecksum()

◆ ForcePayloadSize()

◆ GetChecksum()

◆ GetDestinationPort()

◆ GetInstanceTypeId()

◆ GetSerializedSize()

◆ GetSourcePort()

◆ GetTypeId()

◆ InitializeChecksum() [1/3]

◆ InitializeChecksum() [2/3]

◆ InitializeChecksum() [3/3]

◆ IsChecksumOk()

◆ Print()

◆ Serialize()

◆ SetDestinationPort()

◆ SetSourcePort()

Member Data Documentation

◆ m_calcChecksum

◆ m_checksum

◆ m_destination

◆ m_destinationPort

◆ m_forcedPayloadSize

◆ m_goodChecksum

◆ m_payloadSize

◆ m_protocol

◆ m_source

◆ m_sourcePort