Packet header for UDP packets. More...
#include <udp-header.h>
Public Member Functions | |
UdpHeader () | |
Constructor. | |
~UdpHeader () | |
void | EnableChecksums (void) |
Enable checksum calculation for UDP (XXX currently has no effect). | |
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. | |
Private Member Functions | |
uint16_t | CalculateHeaderChecksum (uint16_t size) const |
Private Attributes | |
uint16_t | m_sourcePort |
uint16_t | m_destinationPort |
uint16_t | m_payloadSize |
Ipv4Address | m_source |
Ipv4Address | m_destination |
uint8_t | m_protocol |
bool | m_calcChecksum |
bool | m_goodChecksum |
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 38 of file udp-header.h.
ns3::UdpHeader::UdpHeader | ( | ) |
ns3::UdpHeader::~UdpHeader | ( | ) |
Definition at line 37 of file udp-header.cc.
uint16_t ns3::UdpHeader::CalculateHeaderChecksum | ( | uint16_t | size | ) | const [private] |
Definition at line 80 of file udp-header.cc.
Referenced by Serialize().
uint32_t ns3::UdpHeader::Deserialize | ( | Buffer::Iterator | start | ) | [virtual] |
start | an iterator which points to where the header should written. |
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 156 of file udp-header.cc.
void ns3::UdpHeader::EnableChecksums | ( | void | ) |
Enable checksum calculation for UDP (XXX currently has no effect).
Definition at line 45 of file udp-header.cc.
References m_calcChecksum.
Referenced by ns3::UdpL4Protocol::Receive(), and ns3::UdpL4Protocol::Send().
uint16_t ns3::UdpHeader::GetDestinationPort | ( | void | ) | const |
Definition at line 66 of file udp-header.cc.
Referenced by ns3::UdpL4Protocol::Receive().
TypeId ns3::UdpHeader::GetInstanceTypeId | ( | void | ) | const [virtual] |
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 115 of file udp-header.cc.
uint32_t ns3::UdpHeader::GetSerializedSize | ( | void | ) | const [virtual] |
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 129 of file udp-header.cc.
uint16_t ns3::UdpHeader::GetSourcePort | ( | void | ) | const |
Definition at line 61 of file udp-header.cc.
Referenced by ns3::UdpL4Protocol::Receive().
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.
Definition at line 106 of file udp-header.cc.
References ns3::TypeId::SetParent().
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 71 of file udp-header.cc.
Referenced by ns3::UdpL4Protocol::Receive(), and ns3::UdpL4Protocol::Send().
bool ns3::UdpHeader::IsChecksumOk | ( | void | ) | const |
Is the UDP checksum correct ?
Definition at line 99 of file udp-header.cc.
References m_goodChecksum.
Referenced by ns3::UdpL4Protocol::Receive().
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.
Definition at line 120 of file udp-header.cc.
void ns3::UdpHeader::Serialize | ( | Buffer::Iterator | start | ) | const [virtual] |
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 135 of file udp-header.cc.
References CalculateHeaderChecksum(), ns3::Buffer::Iterator::CalculateIpChecksum(), ns3::Buffer::Iterator::GetSize(), m_calcChecksum, m_destinationPort, 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 51 of file udp-header.cc.
References m_destinationPort.
Referenced by ns3::UdpL4Protocol::Send().
void ns3::UdpHeader::SetSourcePort | ( | uint16_t | port | ) |
port | The source port for this UdpHeader |
Definition at line 56 of file udp-header.cc.
Referenced by ns3::UdpL4Protocol::Send().
bool ns3::UdpHeader::m_calcChecksum [private] |
Definition at line 108 of file udp-header.h.
Referenced by EnableChecksums(), and Serialize().
Ipv4Address ns3::UdpHeader::m_destination [private] |
Definition at line 106 of file udp-header.h.
uint16_t ns3::UdpHeader::m_destinationPort [private] |
Definition at line 102 of file udp-header.h.
Referenced by Serialize(), and SetDestinationPort().
bool ns3::UdpHeader::m_goodChecksum [private] |
Definition at line 109 of file udp-header.h.
Referenced by IsChecksumOk().
uint16_t ns3::UdpHeader::m_payloadSize [private] |
Definition at line 103 of file udp-header.h.
uint8_t ns3::UdpHeader::m_protocol [private] |
Definition at line 107 of file udp-header.h.
Ipv4Address ns3::UdpHeader::m_source [private] |
Definition at line 105 of file udp-header.h.
uint16_t ns3::UdpHeader::m_sourcePort [private] |
Definition at line 101 of file udp-header.h.
Referenced by Serialize().