Headers for A-MPDU subframes. More...

#include "ampdu-subframe-header.h"

Inheritance diagram for ns3::AmpduSubframeHeader:

Collaboration diagram for ns3::AmpduSubframeHeader:

Public Member Functions
	AmpduSubframeHeader ()

	~AmpduSubframeHeader () override

uint32_t	Deserialize (Buffer::Iterator start) override

bool	GetEof () const
	Return the EOF field.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

uint16_t	GetLength () const
	Return the length field.

uint32_t	GetSerializedSize () const override

bool	IsSignatureValid () const
	Return whether the pattern stored in the delimiter signature field is correct, i.e.

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

void	Serialize (Buffer::Iterator start) const override

void	SetEof (bool eof)
	Set the EOF field.

void	SetLength (uint16_t length)
	Set the length field.

Public Member Functions inherited from ns3::Header
	~Header () override

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

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.

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

Private Attributes
bool	m_eof
	EOF field.

uint16_t	m_length
	length field in bytes

uint8_t	m_signature
	delimiter signature (should correspond to pattern 0x4E in order to be assumed valid)

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

Headers for A-MPDU subframes.

Definition at line 21 of file ampdu-subframe-header.h.

Constructor & Destructor Documentation

◆ AmpduSubframeHeader()

ns3::AmpduSubframeHeader::AmpduSubframeHeader ( )

Definition at line 34 of file ampdu-subframe-header.cc.

◆ ~AmpduSubframeHeader()

ns3::AmpduSubframeHeader::~AmpduSubframeHeader ( )

override

Definition at line 41 of file ampdu-subframe-header.cc.

Member Function Documentation

◆ Deserialize()

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

overridevirtual

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

Definition at line 60 of file ampdu-subframe-header.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), m_eof, m_length, m_signature, ns3::Buffer::Iterator::ReadLsbtohU16(), and ns3::Buffer::Iterator::ReadU8().

Here is the call graph for this function:

◆ GetEof()

bool ns3::AmpduSubframeHeader::GetEof ( ) const

Return the EOF field.

Returns: the EOF field

Definition at line 97 of file ampdu-subframe-header.cc.

References m_eof.

Referenced by ns3::WifiPhyHelper::GetRadiotapHeader().

Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::AmpduSubframeHeader::GetInstanceTypeId ( ) const

overridevirtual

Get the most derived TypeId for this Object.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Returns: The TypeId associated to the most-derived type of this instance.

Implements ns3::ObjectBase.

Definition at line 29 of file ampdu-subframe-header.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetLength()

uint16_t ns3::AmpduSubframeHeader::GetLength ( ) const

Return the length field.

Returns: the length field in bytes

Definition at line 91 of file ampdu-subframe-header.cc.

References m_length.

Referenced by ns3::WifiPhyHelper::GetRadiotapHeader(), and TracePacketReception().

Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::AmpduSubframeHeader::GetSerializedSize ( ) const

overridevirtual

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.

Implements ns3::Header.

Definition at line 46 of file ampdu-subframe-header.cc.

◆ GetTypeId()

TypeId ns3::AmpduSubframeHeader::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 19 of file ampdu-subframe-header.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsSignatureValid()

bool ns3::AmpduSubframeHeader::IsSignatureValid ( ) const

Return whether the pattern stored in the delimiter signature field is correct, i.e.

corresponds to the unique pattern 0x4E.

Returns: true if the signature is valid, false otherwise

Definition at line 103 of file ampdu-subframe-header.cc.

References m_signature.

◆ Print()

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

overridevirtual

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

Definition at line 72 of file ampdu-subframe-header.cc.

References m_eof, m_length, and m_signature.

◆ Serialize()

void ns3::AmpduSubframeHeader::Serialize ( Buffer::Iterator start ) const

overridevirtual

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.

Implements ns3::Header.

Definition at line 52 of file ampdu-subframe-header.cc.

References m_eof, m_length, m_signature, ns3::Buffer::Iterator::WriteHtolsbU16(), and ns3::Buffer::Iterator::WriteU8().

Here is the call graph for this function:

◆ SetEof()

void ns3::AmpduSubframeHeader::SetEof ( bool eof )

Set the EOF field.

Parameters

eof	set EOF field if true

Definition at line 85 of file ampdu-subframe-header.cc.

References m_eof.

Referenced by ns3::MpduAggregator::GetAmpduSubframeHeader().

Here is the caller graph for this function:

◆ SetLength()

void ns3::AmpduSubframeHeader::SetLength ( uint16_t length )

Set the length field.

Parameters

length in bytes

Definition at line 79 of file ampdu-subframe-header.cc.

References m_length.

Referenced by ns3::MpduAggregator::GetAmpduSubframeHeader().

Here is the caller graph for this function:

Member Data Documentation

◆ m_eof

bool ns3::AmpduSubframeHeader::m_eof

private

EOF field.

Definition at line 74 of file ampdu-subframe-header.h.

Referenced by Deserialize(), GetEof(), Print(), Serialize(), and SetEof().

◆ m_length

uint16_t ns3::AmpduSubframeHeader::m_length

private

length field in bytes

Definition at line 73 of file ampdu-subframe-header.h.

Referenced by Deserialize(), GetLength(), Print(), Serialize(), and SetLength().

◆ m_signature

uint8_t ns3::AmpduSubframeHeader::m_signature

private

delimiter signature (should correspond to pattern 0x4E in order to be assumed valid)

Definition at line 75 of file ampdu-subframe-header.h.

Referenced by Deserialize(), IsSignatureValid(), Print(), and Serialize().

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

src/wifi/model/ampdu-subframe-header.h
src/wifi/model/ampdu-subframe-header.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AmpduSubframeHeader()

◆ ~AmpduSubframeHeader()

Member Function Documentation

◆ Deserialize()

◆ GetEof()

◆ GetInstanceTypeId()

◆ GetLength()

◆ GetSerializedSize()

◆ GetTypeId()

◆ IsSignatureValid()

◆ Print()

◆ Serialize()

◆ SetEof()

◆ SetLength()

Member Data Documentation

◆ m_eof

◆ m_length

◆ m_signature