Packet header for UDP packets. More...

#include <udp-header.h>

Inheritance diagram for ns3::UdpHeader:

Public Member Functions
	UdpHeader ()
	Constructor. More...

virtual uint32_t	Deserialize (Buffer::Iterator start)

void	EnableChecksums (void)
	Enable checksum calculation for UDP.

uint16_t	GetDestinationPort (void) const

virtual TypeId	GetInstanceTypeId (void) const

virtual uint32_t	GetSerializedSize (void) const

uint16_t	GetSourcePort (void) 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 (void) const
	Is the UDP checksum correct ? More...

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

virtual void	Serialize (Buffer::Iterator start) const

void	SetDestinationPort (uint16_t port)

void	SetSourcePort (uint16_t port)

Public Member Functions inherited from ns3::ObjectBase
void	GetAttribute (std::string name, AttributeValue &value) const

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Header
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Chunk
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)

Private Member Functions
uint16_t	CalculateHeaderChecksum (uint16_t size) const

Private Attributes
bool	m_calcChecksum

Address	m_destination

uint16_t	m_destinationPort

bool	m_goodChecksum

uint16_t	m_payloadSize

uint8_t	m_protocol

Address	m_source

uint16_t	m_sourcePort

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)

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.

Doxygen introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.

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

Constructor & Destructor Documentation

ns3::UdpHeader::UdpHeader ( )

Constructor.

Creates a null header

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

Member Function Documentation

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

virtual

Parameters

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

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.

Implements ns3::Header.

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

References ns3::Buffer::Iterator::CalculateIpChecksum(), GetSerializedSize(), ns3::Buffer::Iterator::GetSize(), ns3::Buffer::Iterator::Next(), and ns3::Buffer::Iterator::ReadNtohU16().

uint16_t ns3::UdpHeader::GetDestinationPort ( void ) const

Returns: the destination port for this UdpHeader

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

Referenced by ns3::IpcsClassifier::Classify(), ns3::Ipv4FlowClassifier::Classify(), ns3::EpcTftClassifier::Classify(), and ns3::UdpL4Protocol::Receive().

TypeId ns3::UdpHeader::GetInstanceTypeId ( void ) const

virtual

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

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

Implements ns3::ObjectBase.

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

uint32_t ns3::UdpHeader::GetSerializedSize ( void ) const

virtual

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 165 of file udp-header.cc.

Referenced by Deserialize(), and Print().

uint16_t ns3::UdpHeader::GetSourcePort ( void ) const

Returns: The source port for this UdpHeader

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

Referenced by ns3::IpcsClassifier::Classify(), ns3::Ipv4FlowClassifier::Classify(), ns3::EpcTftClassifier::Classify(), and ns3::UdpL4Protocol::Receive().

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 74 of file udp-header.cc.

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

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 83 of file udp-header.cc.

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 92 of file udp-header.cc.

bool ns3::UdpHeader::IsChecksumOk ( void ) const

Is the UDP checksum correct ?

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

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

Referenced by ns3::UdpL4Protocol::Receive().

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

virtual

Parameters

os output stream This method is used by Packet::Print to print the content of a trailer as ascii data to a c++ output stream. Although the trailer 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 156 of file udp-header.cc.

References GetSerializedSize().

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

virtual

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 171 of file udp-header.cc.

References ns3::Buffer::Iterator::CalculateIpChecksum(), ns3::Buffer::Iterator::GetSize(), ns3::Buffer::Iterator::Next(), ns3::Buffer::Iterator::WriteHtonU16(), and ns3::Buffer::Iterator::WriteU16().

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

Parameters

port	the destination port for this UdpHeader

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

Referenced by ns3::UdpL4Protocol::Send().

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

Parameters

port	The source port for this UdpHeader

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

Referenced by ns3::UdpL4Protocol::Send().

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

Constructor & Destructor Documentation

Member Function Documentation