Public Member Functions | Static Public Member Functions

ns3::Header Class Reference
[Packet]

Protocol header serialization and deserialization. More...

#include <header.h>

Inherits ns3::Chunk.

Inherited by ns3::AlohaNoackMacHeader, ns3::AmsduSubframeHeader, ns3::aodv::RerrHeader, ns3::aodv::RrepAckHeader, ns3::aodv::RrepHeader, ns3::aodv::RreqHeader, ns3::aodv::TypeHeader, ns3::ArpHeader, ns3::BandwidthRequestHeader, ns3::CtrlBAckRequestHeader, ns3::CtrlBAckResponseHeader, ns3::Dcd, ns3::DlMap, ns3::dot11s::MeshHeader, ns3::dot11s::PeerLinkFrameStart, ns3::DsaAck, ns3::DsaReq, ns3::DsaRsp, ns3::EthernetHeader, ns3::flame::FlameHeader, ns3::FragmentationSubheader, ns3::GenericMacHeader, ns3::GrantManagementSubheader, ns3::Icmpv4DestinationUnreachable, ns3::Icmpv4Echo, ns3::Icmpv4Header, ns3::Icmpv4TimeExceeded, ns3::Icmpv6Header, ns3::Icmpv6OptionHeader, ns3::Ipv4Header, ns3::Ipv6ExtensionHeader, ns3::Ipv6Header, ns3::Ipv6OptionHeader, ns3::LlcSnapHeader, ns3::MacHeaderType, ns3::ManagementMessageType, ns3::MgtAddBaRequestHeader, ns3::MgtAddBaResponseHeader, ns3::MgtAssocRequestHeader, ns3::MgtAssocResponseHeader, ns3::MgtDelBaHeader, ns3::MgtProbeRequestHeader, ns3::MgtProbeResponseHeader, ns3::OfdmDownlinkFramePrefix, ns3::olsr::MessageHeader, ns3::olsr::PacketHeader, ns3::PppHeader, ns3::RadiotapHeader, ns3::RngReq, ns3::RngRsp, ns3::SeqTsHeader, ns3::TcpHeader, ns3::Tlv, ns3::UanHeaderCommon, ns3::UanHeaderRcAck, ns3::UanHeaderRcCts, ns3::UanHeaderRcCtsGlobal, ns3::UanHeaderRcData, ns3::UanHeaderRcRts, ns3::Ucd, ns3::UdpHeader, ns3::UlMap, ns3::WifiActionHeader, ns3::WifiInformationElementVector, ns3::WifiMacHeader, ns3::WimaxMacToMacHeader, and ns3::SimpleRefCount< PbbPacket, Header >.

Collaboration diagram for ns3::Header:
Collaboration graph
[legend]

List of all members.

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::dot11s::MeshHeader, ns3::dot11s::PeerLinkFrameStart, ns3::flame::FlameHeader, ns3::PppHeader, ns3::AlohaNoackMacHeader, ns3::UanHeaderCommon, ns3::UanHeaderRcData, ns3::UanHeaderRcRts, ns3::UanHeaderRcCtsGlobal, ns3::UanHeaderRcCts, ns3::UanHeaderRcAck, ns3::AmsduSubframeHeader, ns3::CtrlBAckRequestHeader, ns3::CtrlBAckResponseHeader, ns3::MgtAssocRequestHeader, ns3::MgtAssocResponseHeader, ns3::MgtProbeRequestHeader, ns3::MgtProbeResponseHeader, ns3::WifiActionHeader, ns3::MgtAddBaRequestHeader, ns3::MgtAddBaResponseHeader, ns3::MgtDelBaHeader, ns3::WifiInformationElementVector, ns3::WifiMacHeader, ns3::Dcd, ns3::DlMap, ns3::ManagementMessageType, ns3::RngRsp, ns3::DsaReq, ns3::DsaRsp, ns3::DsaAck, ns3::RngReq, ns3::OfdmDownlinkFramePrefix, ns3::Ucd, ns3::UlMap, ns3::MacHeaderType, ns3::GenericMacHeader, ns3::BandwidthRequestHeader, ns3::GrantManagementSubheader, ns3::FragmentationSubheader, ns3::WimaxMacToMacHeader, ns3::Tlv, ns3::ArpHeader, ns3::Icmpv4Header, ns3::Icmpv4Echo, ns3::Icmpv4TimeExceeded, ns3::Icmpv6Header, ns3::Icmpv6OptionHeader, ns3::Icmpv6NS, ns3::Icmpv6NA, ns3::Icmpv6RA, ns3::Icmpv6RS, ns3::Icmpv6Redirection, ns3::Icmpv6Echo, ns3::Icmpv6DestinationUnreachable, ns3::Icmpv6TooBig, ns3::Icmpv6TimeExceeded, ns3::Icmpv6ParameterError, ns3::Icmpv6OptionMtu, ns3::Icmpv6OptionPrefixInformation, ns3::Icmpv6OptionLinkLayerAddress, ns3::Icmpv6OptionRedirected, ns3::Ipv6ExtensionHeader, ns3::Ipv6ExtensionFragmentHeader, ns3::Ipv6ExtensionRoutingHeader, ns3::Ipv6ExtensionLooseRoutingHeader, ns3::Ipv6ExtensionESPHeader, ns3::Ipv6ExtensionAHHeader, ns3::Ipv6OptionHeader, ns3::Ipv6OptionPad1Header, ns3::Ipv6OptionPadnHeader, ns3::Ipv6OptionJumbogramHeader, ns3::Ipv6OptionRouterAlertHeader, ns3::TcpHeader, ns3::UdpHeader, ns3::EthernetHeader, ns3::Ipv4Header, ns3::Ipv6Header, ns3::LlcSnapHeader, ns3::PbbPacket, ns3::RadiotapHeader, ns3::aodv::TypeHeader, ns3::aodv::RreqHeader, ns3::aodv::RrepHeader, ns3::aodv::RrepAckHeader, ns3::aodv::RerrHeader, ns3::olsr::PacketHeader, and ns3::olsr::MessageHeader.

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::dot11s::MeshHeader, ns3::dot11s::PeerLinkFrameStart, ns3::flame::FlameHeader, ns3::PppHeader, ns3::AlohaNoackMacHeader, ns3::UanHeaderCommon, ns3::UanHeaderRcData, ns3::UanHeaderRcRts, ns3::UanHeaderRcCtsGlobal, ns3::UanHeaderRcCts, ns3::UanHeaderRcAck, ns3::AmsduSubframeHeader, ns3::CtrlBAckRequestHeader, ns3::CtrlBAckResponseHeader, ns3::MgtAssocRequestHeader, ns3::MgtAssocResponseHeader, ns3::MgtProbeRequestHeader, ns3::MgtProbeResponseHeader, ns3::WifiActionHeader, ns3::MgtAddBaRequestHeader, ns3::MgtAddBaResponseHeader, ns3::MgtDelBaHeader, ns3::WifiInformationElementVector, ns3::WifiMacHeader, ns3::Dcd, ns3::DlMap, ns3::ManagementMessageType, ns3::RngRsp, ns3::DsaReq, ns3::DsaRsp, ns3::DsaAck, ns3::RngReq, ns3::OfdmDownlinkFramePrefix, ns3::Ucd, ns3::UlMap, ns3::MacHeaderType, ns3::GenericMacHeader, ns3::BandwidthRequestHeader, ns3::GrantManagementSubheader, ns3::FragmentationSubheader, ns3::WimaxMacToMacHeader, ns3::Tlv, ns3::ArpHeader, ns3::Icmpv4Header, ns3::Icmpv4Echo, ns3::Icmpv4TimeExceeded, ns3::Icmpv6Header, ns3::Icmpv6OptionHeader, ns3::Icmpv6NS, ns3::Icmpv6NA, ns3::Icmpv6RA, ns3::Icmpv6RS, ns3::Icmpv6Redirection, ns3::Icmpv6Echo, ns3::Icmpv6DestinationUnreachable, ns3::Icmpv6TooBig, ns3::Icmpv6TimeExceeded, ns3::Icmpv6ParameterError, ns3::Icmpv6OptionMtu, ns3::Icmpv6OptionPrefixInformation, ns3::Icmpv6OptionLinkLayerAddress, ns3::Icmpv6OptionRedirected, ns3::Ipv6ExtensionHeader, ns3::Ipv6ExtensionFragmentHeader, ns3::Ipv6ExtensionRoutingHeader, ns3::Ipv6ExtensionLooseRoutingHeader, ns3::Ipv6ExtensionESPHeader, ns3::Ipv6ExtensionAHHeader, ns3::Ipv6OptionHeader, ns3::Ipv6OptionPad1Header, ns3::Ipv6OptionPadnHeader, ns3::Ipv6OptionJumbogramHeader, ns3::Ipv6OptionRouterAlertHeader, ns3::TcpHeader, ns3::UdpHeader, ns3::EthernetHeader, ns3::Ipv4Header, ns3::Ipv6Header, ns3::LlcSnapHeader, ns3::PbbPacket, ns3::RadiotapHeader, ns3::aodv::TypeHeader, ns3::aodv::RreqHeader, ns3::aodv::RrepHeader, ns3::aodv::RrepAckHeader, ns3::aodv::RerrHeader, ns3::olsr::PacketHeader, and ns3::olsr::MessageHeader.

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::SeqTsHeader, ns3::dot11s::MeshHeader, ns3::dot11s::PeerLinkFrameStart, ns3::flame::FlameHeader, ns3::PppHeader, ns3::AlohaNoackMacHeader, ns3::UanHeaderCommon, ns3::UanHeaderRcData, ns3::UanHeaderRcRts, ns3::UanHeaderRcCtsGlobal, ns3::UanHeaderRcCts, ns3::UanHeaderRcAck, ns3::AmsduSubframeHeader, ns3::CtrlBAckRequestHeader, ns3::CtrlBAckResponseHeader, ns3::MgtAssocRequestHeader, ns3::MgtAssocResponseHeader, ns3::MgtProbeRequestHeader, ns3::MgtProbeResponseHeader, ns3::WifiActionHeader, ns3::MgtAddBaRequestHeader, ns3::MgtAddBaResponseHeader, ns3::MgtDelBaHeader, ns3::WifiInformationElementVector, ns3::WifiMacHeader, ns3::Dcd, ns3::DlMap, ns3::ManagementMessageType, ns3::RngRsp, ns3::DsaReq, ns3::DsaRsp, ns3::DsaAck, ns3::RngReq, ns3::Ucd, ns3::UlMap, ns3::MacHeaderType, ns3::GenericMacHeader, ns3::BandwidthRequestHeader, ns3::GrantManagementSubheader, ns3::FragmentationSubheader, ns3::WimaxMacToMacHeader, ns3::ArpHeader, ns3::Icmpv4Header, ns3::Icmpv4Echo, ns3::Icmpv4DestinationUnreachable, ns3::Icmpv4TimeExceeded, ns3::Icmpv6Header, ns3::Icmpv6OptionHeader, ns3::Icmpv6NS, ns3::Icmpv6NA, ns3::Icmpv6RA, ns3::Icmpv6RS, ns3::Icmpv6Redirection, ns3::Icmpv6Echo, ns3::Icmpv6DestinationUnreachable, ns3::Icmpv6TooBig, ns3::Icmpv6TimeExceeded, ns3::Icmpv6ParameterError, ns3::Icmpv6OptionMtu, ns3::Icmpv6OptionPrefixInformation, ns3::Icmpv6OptionLinkLayerAddress, ns3::Icmpv6OptionRedirected, ns3::Ipv6ExtensionHeader, ns3::Ipv6ExtensionFragmentHeader, ns3::Ipv6ExtensionRoutingHeader, ns3::Ipv6ExtensionLooseRoutingHeader, ns3::Ipv6ExtensionESPHeader, ns3::Ipv6ExtensionAHHeader, ns3::Ipv6OptionHeader, ns3::Ipv6OptionPad1Header, ns3::Ipv6OptionPadnHeader, ns3::Ipv6OptionJumbogramHeader, ns3::Ipv6OptionRouterAlertHeader, ns3::TcpHeader, ns3::UdpHeader, ns3::EthernetHeader, ns3::Ipv4Header, ns3::Ipv6Header, ns3::LlcSnapHeader, ns3::PbbPacket, ns3::RadiotapHeader, ns3::aodv::TypeHeader, ns3::aodv::RreqHeader, ns3::aodv::RrepHeader, ns3::aodv::RrepAckHeader, ns3::aodv::RerrHeader, ns3::olsr::PacketHeader, and ns3::olsr::MessageHeader.

virtual void ns3::Header::Print ( std::ostream &  os  )  const [pure 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::Chunk.

Implemented in ns3::dot11s::MeshHeader, ns3::dot11s::PeerLinkFrameStart, ns3::flame::FlameHeader, ns3::PppHeader, ns3::AlohaNoackMacHeader, ns3::UanHeaderCommon, ns3::UanHeaderRcData, ns3::UanHeaderRcRts, ns3::UanHeaderRcCtsGlobal, ns3::UanHeaderRcCts, ns3::UanHeaderRcAck, ns3::AmsduSubframeHeader, ns3::CtrlBAckRequestHeader, ns3::CtrlBAckResponseHeader, ns3::MgtAssocRequestHeader, ns3::MgtAssocResponseHeader, ns3::MgtProbeRequestHeader, ns3::MgtProbeResponseHeader, ns3::WifiActionHeader, ns3::MgtAddBaRequestHeader, ns3::MgtAddBaResponseHeader, ns3::MgtDelBaHeader, ns3::WifiInformationElementVector, ns3::WifiMacHeader, ns3::Dcd, ns3::DlMap, ns3::ManagementMessageType, ns3::RngRsp, ns3::DsaReq, ns3::DsaRsp, ns3::DsaAck, ns3::RngReq, ns3::OfdmDownlinkFramePrefix, ns3::Ucd, ns3::UlMap, ns3::MacHeaderType, ns3::GenericMacHeader, ns3::BandwidthRequestHeader, ns3::GrantManagementSubheader, ns3::FragmentationSubheader, ns3::WimaxMacToMacHeader, ns3::Tlv, ns3::ArpHeader, ns3::Icmpv4Header, ns3::Icmpv4Echo, ns3::Icmpv4TimeExceeded, ns3::Icmpv6Header, ns3::Icmpv6OptionHeader, ns3::Icmpv6NS, ns3::Icmpv6NA, ns3::Icmpv6RA, ns3::Icmpv6RS, ns3::Icmpv6Redirection, ns3::Icmpv6Echo, ns3::Icmpv6DestinationUnreachable, ns3::Icmpv6TooBig, ns3::Icmpv6TimeExceeded, ns3::Icmpv6ParameterError, ns3::Icmpv6OptionMtu, ns3::Icmpv6OptionPrefixInformation, ns3::Icmpv6OptionLinkLayerAddress, ns3::Icmpv6OptionRedirected, ns3::Ipv6ExtensionHeader, ns3::Ipv6ExtensionFragmentHeader, ns3::Ipv6ExtensionRoutingHeader, ns3::Ipv6ExtensionLooseRoutingHeader, ns3::Ipv6ExtensionESPHeader, ns3::Ipv6ExtensionAHHeader, ns3::Ipv6OptionHeader, ns3::Ipv6OptionPad1Header, ns3::Ipv6OptionPadnHeader, ns3::Ipv6OptionJumbogramHeader, ns3::Ipv6OptionRouterAlertHeader, ns3::TcpHeader, ns3::UdpHeader, ns3::EthernetHeader, ns3::Ipv4Header, ns3::Ipv6Header, ns3::LlcSnapHeader, ns3::PbbPacket, ns3::RadiotapHeader, ns3::aodv::TypeHeader, ns3::aodv::RreqHeader, ns3::aodv::RrepHeader, ns3::aodv::RrepAckHeader, ns3::aodv::RerrHeader, ns3::olsr::PacketHeader, and ns3::olsr::MessageHeader.

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::dot11s::MeshHeader, ns3::dot11s::PeerLinkFrameStart, ns3::flame::FlameHeader, ns3::PppHeader, ns3::AlohaNoackMacHeader, ns3::UanHeaderCommon, ns3::UanHeaderRcData, ns3::UanHeaderRcRts, ns3::UanHeaderRcCtsGlobal, ns3::UanHeaderRcCts, ns3::UanHeaderRcAck, ns3::AmsduSubframeHeader, ns3::CtrlBAckRequestHeader, ns3::CtrlBAckResponseHeader, ns3::MgtAssocRequestHeader, ns3::MgtAssocResponseHeader, ns3::MgtProbeRequestHeader, ns3::MgtProbeResponseHeader, ns3::WifiActionHeader, ns3::MgtAddBaRequestHeader, ns3::MgtAddBaResponseHeader, ns3::MgtDelBaHeader, ns3::WifiInformationElementVector, ns3::WifiMacHeader, ns3::Dcd, ns3::DlMap, ns3::ManagementMessageType, ns3::RngRsp, ns3::DsaReq, ns3::DsaRsp, ns3::DsaAck, ns3::RngReq, ns3::OfdmDownlinkFramePrefix, ns3::Ucd, ns3::UlMap, ns3::MacHeaderType, ns3::GenericMacHeader, ns3::BandwidthRequestHeader, ns3::GrantManagementSubheader, ns3::FragmentationSubheader, ns3::WimaxMacToMacHeader, ns3::Tlv, ns3::ArpHeader, ns3::Icmpv4Header, ns3::Icmpv4Echo, ns3::Icmpv4TimeExceeded, ns3::Icmpv6Header, ns3::Icmpv6OptionHeader, ns3::Icmpv6NS, ns3::Icmpv6NA, ns3::Icmpv6RA, ns3::Icmpv6RS, ns3::Icmpv6Redirection, ns3::Icmpv6Echo, ns3::Icmpv6DestinationUnreachable, ns3::Icmpv6TooBig, ns3::Icmpv6TimeExceeded, ns3::Icmpv6ParameterError, ns3::Icmpv6OptionMtu, ns3::Icmpv6OptionPrefixInformation, ns3::Icmpv6OptionLinkLayerAddress, ns3::Icmpv6OptionRedirected, ns3::Ipv6ExtensionHeader, ns3::Ipv6ExtensionFragmentHeader, ns3::Ipv6ExtensionRoutingHeader, ns3::Ipv6ExtensionLooseRoutingHeader, ns3::Ipv6ExtensionESPHeader, ns3::Ipv6ExtensionAHHeader, ns3::Ipv6OptionHeader, ns3::Ipv6OptionPad1Header, ns3::Ipv6OptionPadnHeader, ns3::Ipv6OptionJumbogramHeader, ns3::Ipv6OptionRouterAlertHeader, ns3::TcpHeader, ns3::UdpHeader, ns3::EthernetHeader, ns3::Ipv4Header, ns3::Ipv6Header, ns3::LlcSnapHeader, ns3::PbbPacket, ns3::RadiotapHeader, ns3::aodv::TypeHeader, ns3::aodv::RreqHeader, ns3::aodv::RrepHeader, ns3::aodv::RrepAckHeader, ns3::aodv::RerrHeader, ns3::olsr::PacketHeader, and ns3::olsr::MessageHeader.

The documentation for this class was generated from the following files:
Generated on Fri Feb 18 2011 15:54:50 for NS-3 by  doxygen 1.7.1