Protocol header serialization and deserialization. More...
#include <header.h>
Public Member Functions | |
| virtual uint32_t | GetSerializedSize (void) const =0 |
| virtual void | Serialize (Buffer::Iterator start) const =0 |
| virtual uint32_t | Deserialize (Buffer::Iterator start)=0 |
| virtual void | Print (std::ostream &os) const =0 |
Static Public Member Functions | |
| static TypeId | GetTypeId (void) |
| This method returns the TypeId associated to ns3::Header. | |
Detailed Description
Protocol header serialization and deserialization.
Every Protocol header which needs to be inserted or removed from a Packet instance must derive from this base class and implement the pure virtual methods defined here.
Sample code which shows how to create a new type of Header, and how to use it, is shown in the sample file samples/main-packet-header.cc
Member Function Documentation
| virtual uint32_t ns3::Header::Deserialize | ( | Buffer::Iterator | start | ) | [pure 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::Chunk.
Implemented in ns3::PppHeader, ns3::ArpHeader, ns3::TcpHeader, ns3::UdpHeader, ns3::EthernetHeader, ns3::Ipv4Header, and ns3::LlcSnapHeader.
| virtual uint32_t ns3::Header::GetSerializedSize | ( | void | ) | const [pure 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.
Implemented in ns3::PppHeader, ns3::ArpHeader, ns3::TcpHeader, ns3::UdpHeader, ns3::EthernetHeader, ns3::Ipv4Header, and ns3::LlcSnapHeader.
| static TypeId ns3::Header::GetTypeId | ( | void | ) | [static] |
This method returns the TypeId associated to ns3::Header.
No Attributes defined for this type.
No TraceSources defined for this type.
Reimplemented from ns3::Chunk.
Reimplemented in ns3::PppHeader, ns3::ArpHeader, ns3::TcpHeader, ns3::UdpHeader, ns3::EthernetHeader, ns3::Ipv4Header, and ns3::LlcSnapHeader.
| virtual void ns3::Header::Print | ( | std::ostream & | os | ) | const [pure 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::Chunk.
Implemented in ns3::PppHeader, ns3::ArpHeader, ns3::TcpHeader, ns3::UdpHeader, ns3::EthernetHeader, ns3::Ipv4Header, and ns3::LlcSnapHeader.
| virtual void ns3::Header::Serialize | ( | Buffer::Iterator | start | ) | const [pure 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.
Implemented in ns3::PppHeader, ns3::ArpHeader, ns3::TcpHeader, ns3::UdpHeader, ns3::EthernetHeader, ns3::Ipv4Header, and ns3::LlcSnapHeader.
The documentation for this class was generated from the following files:
- src/common/header.h
- doc/introspected-doxygen.h
