ns3::UdpHeader Class Reference
[Udp]

Packet header for UDP packets. More...

#include <udp-header.h>

Inheritance diagram for ns3::UdpHeader:

[legend]

Collaboration diagram for ns3::UdpHeader:

[legend]

List of all members.

Public Member Functions
	UdpHeader ()
	Constructor.
void	EnableChecksums (void)
	Enable checksum calculation for UDP.
void	SetDestinationPort (uint16_t port)
void	SetSourcePort (uint16_t port)
uint16_t	GetSourcePort (void) const
uint16_t	GetDestinationPort (void) const
void	InitializeChecksum (Ipv4Address source, Ipv4Address destination, uint8_t protocol)
virtual TypeId	GetInstanceTypeId (void) const
virtual void	Print (std::ostream &os) const
virtual uint32_t	GetSerializedSize (void) const
virtual void	Serialize (Buffer::Iterator start) const
virtual uint32_t	Deserialize (Buffer::Iterator start)
bool	IsChecksumOk (void) const
	Is the UDP checksum correct ?
Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::UdpHeader.

---

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.

---

Constructor & Destructor Documentation

ns3::UdpHeader::UdpHeader

(

)

Constructor.

Creates a null header

---

Member Function Documentation

virtual 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.

uint16_t ns3::UdpHeader::GetDestinationPort

(

void

)

const

Returns:

the destination port for this UdpHeader

virtual 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.

virtual 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.

uint16_t ns3::UdpHeader::GetSourcePort

(

void

)

const

Returns:

The source port for this UdpHeader

static TypeId ns3::UdpHeader::GetTypeId

(

void

)

[static]

This method returns the TypeId associated to ns3::UdpHeader.

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::Header.

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.

bool ns3::UdpHeader::IsChecksumOk

(

void

)

const

Is the UDP checksum correct ?

Returns:

true if the checksum is correct, false otherwise.

virtual void ns3::UdpHeader::Print

(

std::ostream &

os

)

const [virtual]

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.

virtual 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.

void ns3::UdpHeader::SetDestinationPort

(

uint16_t

port

)

Parameters:

port

the destination port for this UdpHeader

void ns3::UdpHeader::SetSourcePort

(

uint16_t

port

)

Parameters:

port

The source port for this UdpHeader

---

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

• src/internet-stack/udp-header.h
• doc/introspected-doxygen.h