Protocol header serialization and deserialization. More...

#include <header.h>

Inheritance diagram for ns3::Header:

Public Member Functions
virtual uint32_t	Deserialize (Buffer::Iterator start)=0

virtual uint32_t	GetSerializedSize (void) const =0

virtual void	Print (std::ostream &os) const =0

virtual void	Serialize (Buffer::Iterator start) const =0

Public Member Functions inherited from ns3::ObjectBase
void	GetAttribute (std::string name, AttributeValue &value) const

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

virtual TypeId	GetInstanceTypeId (void) const =0

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Chunk
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)

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

Doxygen introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 42 of file header.h.

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.

Referenced by ns3::Packet::PeekHeader(), and ns3::Packet::RemoveHeader().

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::Icmpv6OptionRedirected, ns3::Icmpv6OptionLinkLayerAddress, ns3::Icmpv6OptionPrefixInformation, ns3::Icmpv6OptionMtu, ns3::dsr::DsrOptionAckHeader, ns3::Icmpv6ParameterError, ns3::Icmpv6TimeExceeded, ns3::dsr::DsrOptionAckReqHeader, ns3::Icmpv6TooBig, ns3::dsr::DsrOptionRerrUnsupportHeader, ns3::Icmpv6DestinationUnreachable, ns3::Icmpv6Echo, ns3::dsr::DsrOptionRerrUnreachHeader, ns3::Icmpv6Redirection, ns3::dsr::DsrOptionRerrHeader, ns3::Icmpv6RS, ns3::Ipv6ExtensionAHHeader, ns3::Icmpv6RA, ns3::dsr::DsrOptionSRHeader, ns3::Ipv6ExtensionESPHeader, ns3::PbbPacket, ns3::Ipv6ExtensionLooseRoutingHeader, ns3::IdealHandoverCommandHeader, ns3::dsr::DsrOptionRrepHeader, ns3::Icmpv6NA, ns3::Ipv6ExtensionRoutingHeader, ns3::RngReq, ns3::IdealHandoverPreparationInfoHeader, ns3::DsaAck, ns3::Ipv6ExtensionFragmentHeader, ns3::Icmpv6NS, ns3::Ipv6OptionRouterAlertHeader, ns3::DsaRsp, ns3::dsr::DsrOptionRreqHeader, ns3::MgtDelBaHeader, ns3::UanHeaderRcAck, ns3::UlMap, ns3::DlMap, ns3::MgtAddBaResponseHeader, ns3::Ipv6OptionJumbogramHeader, ns3::EpcX2ResourceStatusUpdateHeader, ns3::UanHeaderRcCts, ns3::Ipv6ExtensionDestinationHeader, ns3::dsr::DsrRoutingHeader, ns3::DsaReq, ns3::aodv::RerrHeader, ns3::Icmpv6OptionHeader, ns3::EpcX2LoadInformationHeader, ns3::FragmentationSubheader, ns3::MgtAddBaRequestHeader, ns3::aodv::RrepAckHeader, ns3::EpcX2UeContextReleaseHeader, ns3::Ipv6ExtensionHopByHopHeader, ns3::WifiActionHeader, ns3::Ipv6OptionPadnHeader, ns3::Dcd, ns3::GrantManagementSubheader, ns3::dsr::DsrOptionPadnHeader, ns3::UanHeaderRcCtsGlobal, ns3::Ipv4Header, ns3::Ucd, ns3::EpcX2SnStatusTransferHeader, ns3::olsr::MessageHeader, ns3::aodv::RrepHeader, ns3::RngRsp, ns3::Ipv6OptionPad1Header, ns3::Icmpv6Header, ns3::EpcX2HandoverPreparationFailureHeader, ns3::dsr::DsrOptionPad1Header, ns3::BandwidthRequestHeader, ns3::Ipv6Header, ns3::dsr::DsrFsHeader, ns3::UanHeaderRcRts, ns3::TcpHeader, ns3::Icmpv4TimeExceeded, ns3::MgtProbeResponseHeader, ns3::EpcX2HandoverRequestAckHeader, ns3::LteRlcAmHeader, OptionWithAlignmentHeader, ns3::UdpHeader, ns3::Icmpv4DestinationUnreachable, ns3::MgtProbeRequestHeader, ns3::aodv::RreqHeader, ns3::GenericMacHeader, ns3::dsr::DsrOptionHeader, ns3::CtrlBAckResponseHeader, ns3::Ipv6OptionHeader, ns3::EthernetHeader, anonymous_namespace{packet-test-suite.cc}::ATestHeader< N >, ns3::olsr::PacketHeader, ns3::WifiMacHeader, ns3::OfdmDownlinkFramePrefix, ns3::Ipv6ExtensionHeader, ns3::EpcX2HandoverRequestHeader, ns3::MgtAssocResponseHeader, ns3::LteRlcHeader, ns3::Tlv, ns3::Icmpv4Echo, ns3::UanHeaderCommon, anonymous_namespace{packet-metadata-test.cc}::HistoryHeader< N >, ns3::UanHeaderRcData, ns3::dot11s::PeerLinkFrameStart, ns3::ManagementMessageType, OptionWithoutAlignmentHeader, ns3::PppHeader, ns3::dsdv::DsdvHeader, ns3::LtePdcpHeader, ns3::aodv::TypeHeader, ns3::dot11s::MeshHeader, ns3::RadiotapHeader, ns3::SeqTsHeader, ns3::MacHeaderType, ns3::MgtAssocRequestHeader, ns3::ArpHeader, ns3::Icmpv4Header, ns3::CtrlBAckRequestHeader, ns3::WifiInformationElementVector, ns3::LlcSnapHeader, ns3::flame::FlameHeader, ns3::Asn1Header, ns3::GtpuHeader, ns3::WimaxMacToMacHeader, ns3::AmsduSubframeHeader, ns3::EpcX2Header, BenchHeader< N >, ns3::AlohaNoackMacHeader, and MyHeader.

Referenced by ns3::Packet::AddHeader(), and ns3::PcapFile::Write().

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.

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.

Referenced by ns3::Packet::AddHeader(), and ns3::PcapFile::Write().

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

src/network/model/header.h
src/network/model/header.cc

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation