Protocol header serialization and deserialization. More...

#include "header.h"

Inherited by ns3::SimpleRefCount< PbbPacket, Header >, BenchHeader< N >, MyHeader, anonymous_namespace{packet-metadata-test.cc}::HistoryHeaderBase, anonymous_namespace{packet-test-suite.cc}::ATestHeaderBase, ns3::AlohaNoackMacHeader, ns3::AmpduSubframeHeader, ns3::AmsduSubframeHeader, ns3::ArpHeader, ns3::Asn1Header, ns3::BandwidthRequestHeader, ns3::CtrlBAckRequestHeader, ns3::CtrlBAckResponseHeader, ns3::CtrlTriggerHeader, ns3::Dcd, ns3::DhcpHeader, ns3::DlMap, ns3::DsaAck, ns3::DsaReq, ns3::DsaRsp, ns3::EpcX2HandoverCancelHeader, ns3::EpcX2HandoverPreparationFailureHeader, ns3::EpcX2HandoverRequestAckHeader, ns3::EpcX2HandoverRequestHeader, ns3::EpcX2Header, ns3::EpcX2LoadInformationHeader, ns3::EpcX2ResourceStatusUpdateHeader, ns3::EpcX2SnStatusTransferHeader, ns3::EpcX2UeContextReleaseHeader, ns3::EthernetHeader, ns3::FilsDiscHeader, ns3::FragmentationSubheader, ns3::GenericMacHeader, ns3::GrantManagementSubheader, ns3::GtpcHeader, ns3::GtpuHeader, ns3::Icmpv4DestinationUnreachable, ns3::Icmpv4Echo, ns3::Icmpv4Header, ns3::Icmpv4TimeExceeded, ns3::Icmpv6Header, ns3::Icmpv6OptionHeader, ns3::IdealHandoverCommandHeader, ns3::IdealHandoverPreparationInfoHeader, ns3::Ipv4Header, ns3::Ipv6ExtensionHeader, ns3::Ipv6Header, ns3::Ipv6OptionHeader, ns3::LlcSnapHeader, ns3::LtePdcpHeader, ns3::LteRlcAmHeader, ns3::LteRlcHeader, ns3::MacHeaderType, ns3::ManagementMessageType, ns3::MeshInformationElementVector, ns3::MgtAddBaRequestHeader, ns3::MgtAddBaResponseHeader, ns3::MgtDelBaHeader, ns3::MgtEmlOmn, ns3::OfdmDownlinkFramePrefix, ns3::PppHeader, ns3::RadiotapHeader, ns3::RipHeader, ns3::RipNgHeader, ns3::RipNgRte, ns3::RipRte, ns3::RngReq, ns3::RngRsp, ns3::SeqTsEchoHeader, ns3::SeqTsHeader, ns3::SixLowPanBc0, ns3::SixLowPanFrag1, ns3::SixLowPanFragN, ns3::SixLowPanHc1, ns3::SixLowPanIphc, ns3::SixLowPanIpv6, ns3::SixLowPanMesh, ns3::SixLowPanNhcExtension, ns3::SixLowPanUdpNhcExtension, ns3::SllHeader, ns3::TcpHeader, ns3::ThreeGppHttpHeader, ns3::Tlv, ns3::UanHeaderCommon, ns3::UanHeaderRcAck, ns3::UanHeaderRcCts, ns3::UanHeaderRcCtsGlobal, ns3::UanHeaderRcData, ns3::UanHeaderRcRts, ns3::Ucd, ns3::UdpHeader, ns3::UlMap, ns3::WifiActionHeader, ns3::WifiMacHeader, ns3::WifiMgtHeader< Derived, std::tuple< Elems... > >, ns3::WimaxMacToMacHeader, ns3::aodv::RerrHeader, ns3::aodv::RrepAckHeader, ns3::aodv::RrepHeader, ns3::aodv::RreqHeader, ns3::aodv::TypeHeader, ns3::dot11s::MeshHeader, ns3::dot11s::PeerLinkCloseStart, ns3::dot11s::PeerLinkConfirmStart, ns3::dot11s::PeerLinkOpenStart, ns3::dsdv::DsdvHeader, ns3::dsr::DsrFsHeader, ns3::dsr::DsrOptionHeader, ns3::flame::FlameHeader, ns3::lorawan::LoraFrameHeader, ns3::lorawan::LorawanMacHeader, ns3::lrwpan::BeaconPayloadHeader, ns3::lrwpan::CommandPayloadHeader, ns3::lrwpan::LrWpanMacHeader, ns3::olsr::MessageHeader, and ns3::olsr::PacketHeader.

Collaboration diagram for ns3::Header:

Public Member Functions
	~Header () override

uint32_t	Deserialize (Buffer::Iterator start) override=0

virtual uint32_t	Deserialize (Buffer::Iterator start, Buffer::Iterator end)
	Deserialize the object from a buffer iterator.

virtual uint32_t	GetSerializedSize () const =0

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

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

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.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

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::Chunk
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

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.

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

Definition at line 32 of file header.h.

Constructor & Destructor Documentation

◆ ~Header()

ns3::Header::~Header ( )

override

Definition at line 20 of file header.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Deserialize() [1/2]

uint32_t ns3::Header::Deserialize ( Buffer::Iterator start )

overridepure virtual

Parameters

start an iterator which points to where the header should read from.

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.

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::Chunk.

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

Here is the caller graph for this function:

◆ Deserialize() [2/2]

uint32_t ns3::Chunk::Deserialize	(	Buffer::Iterator	start,
		Buffer::Iterator	end )

virtual

Deserialize the object from a buffer iterator.

This version of Deserialize must be used when the Chunk has a variable size, because the bounds of the Chunk may not be known at the point of deserialization (e.g. a sequence of TLV fields).

The size of the chunk should be start.GetDistanceFrom (end);

Parameters

start	the starting point
end	the ending point

Returns: the number of deserialized bytes

Reimplemented from ns3::Chunk.

Reimplemented in ns3::MeshInformationElementVector.

Definition at line 58 of file chunk.cc.

◆ GetSerializedSize()

virtual uint32_t ns3::Header::GetSerializedSize ( ) 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.

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

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::Header::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 26 of file header.cc.

References ns3::TypeId::SetParent().

Referenced by ns3::PacketMetadata::ItemIterator::Next().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Print()

void ns3::Header::Print ( std::ostream & os ) const

overridepure virtual

Parameters

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::Chunk.

Referenced by ns3::operator<<().

Here is the caller graph for this function:

◆ Serialize()

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().

Here is the caller graph for this function:

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

Constructor & Destructor Documentation

◆ ~Header()

Member Function Documentation

◆ Deserialize() [1/2]

◆ Deserialize() [2/2]

◆ GetSerializedSize()

◆ GetTypeId()

◆ Print()

◆ Serialize()