Packet header for UDP packets. More...
#include "udp-header.h"
Public Member Functions | |
uint32_t | Deserialize (Buffer::Iterator start) override |
void | EnableChecksums () |
Enable checksum calculation for UDP. | |
void | ForceChecksum (uint16_t checksum) |
Force the UDP checksum to a given value. | |
void | ForcePayloadSize (uint16_t payloadSize) |
Force the UDP payload length to a given value. | |
uint16_t | GetChecksum () const |
Return the checksum (only known after a Deserialize) | |
uint16_t | GetDestinationPort () const |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
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 ? | |
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, Buffer::Iterator end) |
Deserialize the object from a buffer iterator. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Header | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Chunk | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Private Member Functions | |
uint16_t | CalculateHeaderChecksum (uint16_t size) const |
Calculate the header checksum. | |
Private Attributes | |
bool | m_calcChecksum {false} |
Flag to calculate checksum. | |
uint16_t | m_checksum {0} |
Forced Checksum value. | |
Address | m_destination |
Destination IP address. | |
uint16_t | m_destinationPort {0xfffd} |
Destination port. | |
uint16_t | m_forcedPayloadSize {0} |
Payload size (forced) | |
bool | m_goodChecksum {true} |
Flag to indicate that checksum is correct. | |
uint16_t | m_payloadSize {0} |
Payload size. | |
uint8_t | m_protocol {17} |
Protocol number. | |
Address | m_source |
Source IP address. | |
uint16_t | m_sourcePort {0xfffd} |
Source port. | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Packet header for UDP packets.
Introspection did not find any typical Config paths.
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.
No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Internet
Size of this type is 72 bytes (on a 64-bit architecture).
Definition at line 29 of file udp-header.h.
|
private |
Calculate the header checksum.
size | packet size |
Definition at line 73 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().
|
overridevirtual |
start | an iterator which points to where the header should read from. |
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 197 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(), and ns3::Buffer::Iterator::ReadU16().
void ns3::UdpHeader::EnableChecksums | ( | ) |
Enable checksum calculation for UDP.
Definition at line 19 of file udp-header.cc.
References m_calcChecksum.
Referenced by ns3::SixLowPanNetDevice::DecompressLowPanUdpNhc(), ns3::UdpL4Protocol::Receive(), ns3::UdpL4Protocol::Receive(), ns3::UdpL4Protocol::Send(), ns3::UdpL4Protocol::Send(), ns3::UdpL4Protocol::Send(), and ns3::UdpL4Protocol::Send().
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.
checksum | the checksum to use (big endian). |
Definition at line 113 of file udp-header.cc.
References m_checksum.
Referenced by ns3::SixLowPanNetDevice::DecompressLowPanUdpNhc().
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.
payloadSize | the payload length to use. |
Definition at line 119 of file udp-header.cc.
References m_forcedPayloadSize.
uint16_t ns3::UdpHeader::GetChecksum | ( | ) | const |
Return the checksum (only known after a Deserialize)
Definition at line 235 of file udp-header.cc.
References m_checksum.
Referenced by ns3::SixLowPanNetDevice::CompressLowPanUdpNhc().
uint16_t ns3::UdpHeader::GetDestinationPort | ( | ) | const |
Definition at line 43 of file udp-header.cc.
References m_destinationPort.
Referenced by ns3::OpenFlowSwitchNetDevice::BufferFromPacket(), LteIpv6RoutingTestCase::Checker(), ns3::EpcTftClassifier::Classify(), ns3::IpcsClassifier::Classify(), ns3::SixLowPanNetDevice::CompressLowPanUdpNhc(), ns3::Ipv4QueueDiscItem::Hash(), ns3::Ipv6QueueDiscItem::Hash(), ns3::UdpL4Protocol::Receive(), ns3::UdpL4Protocol::Receive(), and ns3::aodv::RoutingProtocol::RouteInput().
|
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.
Implements ns3::ObjectBase.
Definition at line 135 of file udp-header.cc.
References GetTypeId().
|
overridevirtual |
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 148 of file udp-header.cc.
Referenced by Deserialize(), ns3::Rip::DoSendRouteUpdate(), ns3::RipNg::DoSendRouteUpdate(), ns3::Rip::HandleRequests(), ns3::RipNg::HandleRequests(), and Print().
uint16_t ns3::UdpHeader::GetSourcePort | ( | ) | const |
Definition at line 37 of file udp-header.cc.
References m_sourcePort.
Referenced by ns3::OpenFlowSwitchNetDevice::BufferFromPacket(), LteIpv6RoutingTestCase::Checker(), ns3::EpcTftClassifier::Classify(), ns3::IpcsClassifier::Classify(), ns3::SixLowPanNetDevice::CompressLowPanUdpNhc(), ns3::Ipv4QueueDiscItem::Hash(), ns3::Ipv6QueueDiscItem::Hash(), ns3::UdpL4Protocol::Receive(), and ns3::UdpL4Protocol::Receive().
|
static |
Get the type ID.
Definition at line 125 of file udp-header.cc.
References ns3::TypeId::SetParent().
Referenced by GetInstanceTypeId().
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 49 of file udp-header.cc.
References m_destination, m_protocol, and m_source.
Referenced by ns3::SixLowPanNetDevice::DecompressLowPanUdpNhc(), ns3::UdpL4Protocol::Receive(), ns3::UdpL4Protocol::Receive(), ns3::UdpL4Protocol::Send(), ns3::UdpL4Protocol::Send(), ns3::UdpL4Protocol::Send(), and ns3::UdpL4Protocol::Send().
void ns3::UdpHeader::InitializeChecksum | ( | Ipv4Address | source, |
Ipv4Address | destination, | ||
uint8_t | protocol ) |
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 57 of file udp-header.cc.
References m_destination, m_protocol, and m_source.
void ns3::UdpHeader::InitializeChecksum | ( | Ipv6Address | source, |
Ipv6Address | destination, | ||
uint8_t | protocol ) |
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 65 of file udp-header.cc.
References m_destination, m_protocol, and m_source.
bool ns3::UdpHeader::IsChecksumOk | ( | ) | const |
Is the UDP checksum correct ?
Definition at line 107 of file udp-header.cc.
References m_goodChecksum.
Referenced by ns3::SixLowPanNetDevice::CompressLowPanUdpNhc(), ns3::SixLowPanNetDevice::DecompressLowPanUdpNhc(), ns3::UdpL4Protocol::Receive(), and ns3::UdpL4Protocol::Receive().
|
overridevirtual |
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 141 of file udp-header.cc.
References GetSerializedSize(), m_destinationPort, m_payloadSize, and m_sourcePort.
|
overridevirtual |
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 154 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(), ns3::Buffer::Iterator::WriteHtonU16(), and ns3::Buffer::Iterator::WriteU16().
void ns3::UdpHeader::SetDestinationPort | ( | uint16_t | port | ) |
port | the destination port for this UdpHeader |
Definition at line 25 of file udp-header.cc.
References m_destinationPort, and port.
Referenced by EpcTftClassifierTestCase::EpcTftClassifierTestCase(), ns3::SixLowPanNetDevice::DecompressLowPanUdpNhc(), FqCobaltQueueDiscUDPFlowsSeparation::DoRun(), FqCoDelQueueDiscUDPFlowsSeparation::DoRun(), FqPieQueueDiscUDPFlowsSeparation::DoRun(), ns3::UdpL4Protocol::Send(), ns3::UdpL4Protocol::Send(), ns3::UdpL4Protocol::Send(), and ns3::UdpL4Protocol::Send().
void ns3::UdpHeader::SetSourcePort | ( | uint16_t | port | ) |
port | The source port for this UdpHeader |
Definition at line 31 of file udp-header.cc.
References m_sourcePort, and port.
Referenced by EpcTftClassifierTestCase::EpcTftClassifierTestCase(), ns3::SixLowPanNetDevice::DecompressLowPanUdpNhc(), FqCobaltQueueDiscUDPFlowsSeparation::DoRun(), FqCoDelQueueDiscUDPFlowsSeparation::DoRun(), FqPieQueueDiscUDPFlowsSeparation::DoRun(), ns3::UdpL4Protocol::Send(), ns3::UdpL4Protocol::Send(), ns3::UdpL4Protocol::Send(), and ns3::UdpL4Protocol::Send().
|
private |
Flag to calculate checksum.
Definition at line 164 of file udp-header.h.
Referenced by Deserialize(), EnableChecksums(), and Serialize().
|
private |
Forced Checksum value.
Definition at line 163 of file udp-header.h.
Referenced by Deserialize(), ForceChecksum(), GetChecksum(), and Serialize().
|
private |
Destination IP address.
Definition at line 161 of file udp-header.h.
Referenced by CalculateHeaderChecksum(), InitializeChecksum(), InitializeChecksum(), and InitializeChecksum().
|
private |
Destination port.
Definition at line 156 of file udp-header.h.
Referenced by Deserialize(), GetDestinationPort(), Print(), Serialize(), and SetDestinationPort().
|
private |
Payload size (forced)
Definition at line 158 of file udp-header.h.
Referenced by ForcePayloadSize(), and Serialize().
|
private |
Flag to indicate that checksum is correct.
Definition at line 165 of file udp-header.h.
Referenced by Deserialize(), and IsChecksumOk().
|
private |
Payload size.
Definition at line 157 of file udp-header.h.
Referenced by Deserialize(), and Print().
|
private |
Protocol number.
Definition at line 162 of file udp-header.h.
Referenced by CalculateHeaderChecksum(), InitializeChecksum(), InitializeChecksum(), and InitializeChecksum().
|
private |
Source IP address.
Definition at line 160 of file udp-header.h.
Referenced by CalculateHeaderChecksum(), InitializeChecksum(), InitializeChecksum(), and InitializeChecksum().
|
private |
Source port.
Definition at line 155 of file udp-header.h.
Referenced by Deserialize(), GetSourcePort(), Print(), Serialize(), and SetSourcePort().