Headers for Block ack response. More...

#include <ctrl-headers.h>

Inheritance diagram for ns3::CtrlBAckResponseHeader:

Collaboration diagram for ns3::CtrlBAckResponseHeader:

Public Member Functions
	CtrlBAckResponseHeader ()
	~CtrlBAckResponseHeader ()
virtual uint32_t	Deserialize (Buffer::Iterator start)
const uint16_t *	GetBitmap (void) const
uint64_t	GetCompressedBitmap (void) const
virtual TypeId	GetInstanceTypeId (void) const
virtual uint32_t	GetSerializedSize (void) const
uint16_t	GetStartingSequence (void) const
uint16_t	GetStartingSequenceControl (void) const
uint8_t	GetTidInfo (void) const
bool	IsBasic (void) const
bool	IsCompressed (void) const
bool	IsFragmentReceived (uint16_t seq, uint8_t frag) const
bool	IsMultiTid (void) const
bool	IsPacketReceived (uint16_t seq) const
bool	MustSendHtImmediateAck (void) const
virtual void	Print (std::ostream &os) const
void	ResetBitmap (void)
virtual void	Serialize (Buffer::Iterator start) const
void	SetHtImmediateAck (bool immeadiateAck)
void	SetReceivedFragment (uint16_t seq, uint8_t frag)
void	SetReceivedPacket (uint16_t seq)
void	SetStartingSequence (uint16_t seq)
void	SetStartingSequenceControl (uint16_t seqControl)
void	SetTidInfo (uint8_t tid)
void	SetType (enum BlockAckType type)
Public Member Functions inherited from ns3::Header
virtual	~Header ()

Static Public Member Functions
static TypeId	GetTypeId (void)

Private Member Functions
Buffer::Iterator	DeserializeBitmap (Buffer::Iterator start)
uint16_t	GetBaControl (void) const
uint8_t	IndexInBitmap (uint16_t seq) const
bool	IsInBitmap (uint16_t seq) const
Buffer::Iterator	SerializeBitmap (Buffer::Iterator start) const
void	SetBaControl (uint16_t bar)

Private Attributes
union {
uint16_t m_bitmap [64]
uint64_t m_compressedBitmap
}	bitmap
bool	m_baAckPolicy
bool	m_compressed
bool	m_multiTid
uint16_t	m_startingSeq
uint16_t	m_tidInfo

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

Detailed Description

Headers for Block ack response.

802.11n standard includes three types of block ack:

Basic block ack (unique type in 802.11e)
Compressed block ack
Multi-TID block ack For now only basic block ack and compressed block ack are supported. Basic block ack is also default variant.

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 102 of file ctrl-headers.h.

Constructor & Destructor Documentation

ns3::CtrlBAckResponseHeader::CtrlBAckResponseHeader ( )

Definition at line 283 of file ctrl-headers.cc.

References bitmap, and NS_LOG_FUNCTION.

ns3::CtrlBAckResponseHeader::~CtrlBAckResponseHeader ( )

Definition at line 292 of file ctrl-headers.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

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

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

Definition at line 376 of file ctrl-headers.cc.

References DeserializeBitmap(), ns3::Buffer::Iterator::GetDistanceFrom(), m_compressed, m_multiTid, NS_FATAL_ERROR, NS_LOG_FUNCTION, ns3::Buffer::Iterator::ReadLsbtohU16(), SetBaControl(), SetStartingSequenceControl(), and visualizer.core::start().

Here is the call graph for this function:

Buffer::Iterator ns3::CtrlBAckResponseHeader::DeserializeBitmap ( Buffer::Iterator start )

private

Definition at line 567 of file ctrl-headers.cc.

References bitmap, m_compressed, m_multiTid, NS_FATAL_ERROR, NS_LOG_FUNCTION, ns3::Buffer::Iterator::ReadLsbtohU16(), ns3::Buffer::Iterator::ReadLsbtohU64(), and visualizer.core::start().

Referenced by Deserialize().

Here is the call graph for this function:

Here is the caller graph for this function:

uint16_t ns3::CtrlBAckResponseHeader::GetBaControl ( void ) const

private

Definition at line 489 of file ctrl-headers.cc.

References m_baAckPolicy, m_compressed, m_multiTid, m_tidInfo, and NS_LOG_FUNCTION.

Referenced by Serialize().

Here is the caller graph for this function:

const uint16_t * ns3::CtrlBAckResponseHeader::GetBitmap ( void ) const

Definition at line 765 of file ctrl-headers.cc.

References bitmap, and NS_LOG_FUNCTION.

uint64_t ns3::CtrlBAckResponseHeader::GetCompressedBitmap ( void ) const

Definition at line 772 of file ctrl-headers.cc.

References bitmap, and NS_LOG_FUNCTION.

Referenced by CtrlBAckResponseHeaderTest::DoRun().

Here is the caller graph for this function:

TypeId ns3::CtrlBAckResponseHeader::GetInstanceTypeId ( void ) const

virtual

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

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

Implements ns3::ObjectBase.

Definition at line 308 of file ctrl-headers.cc.

References GetTypeId().

Here is the call graph for this function:

uint32_t ns3::CtrlBAckResponseHeader::GetSerializedSize ( void ) const

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.

Implements ns3::Header.

Definition at line 321 of file ctrl-headers.cc.

References m_compressed, m_multiTid, m_tidInfo, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Referenced by ns3::MacLow::GetBlockAckSize().

Here is the caller graph for this function:

uint16_t ns3::CtrlBAckResponseHeader::GetStartingSequence ( void ) const

Definition at line 461 of file ctrl-headers.cc.

References m_startingSeq, and NS_LOG_FUNCTION.

Referenced by ns3::BlockAckCache::FillBlockAckBitmap().

Here is the caller graph for this function:

uint16_t ns3::CtrlBAckResponseHeader::GetStartingSequenceControl ( void ) const

Definition at line 520 of file ctrl-headers.cc.

References m_startingSeq, and NS_LOG_FUNCTION.

Referenced by Serialize().

Here is the caller graph for this function:

uint8_t ns3::CtrlBAckResponseHeader::GetTidInfo ( void ) const

Definition at line 453 of file ctrl-headers.cc.

References m_tidInfo, and NS_LOG_FUNCTION.

Referenced by ns3::BlockAckManager::NotifyGotBlockAck().

Here is the caller graph for this function:

TypeId ns3::CtrlBAckResponseHeader::GetTypeId ( void )

static

Reimplemented from ns3::Header.

Definition at line 298 of file ctrl-headers.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

uint8_t ns3::CtrlBAckResponseHeader::IndexInBitmap ( uint16_t seq ) const

private

This function is used to correctly index in both bitmap and compressed bitmap, one bit or one block of 16 bits respectively.

for more details see 7.2.1.8 in IEEE 802.11n/D4.00

Parameters

seq	the sequence number

Returns: If we are using basic block ack, return value represents index of block of 16 bits for packet having sequence number equals to seq. If we are using compressed block ack, return value represents bit to set to 1 in the compressed bitmap to indicate that packet having sequence number equals to seq was correctly received.

Definition at line 741 of file ctrl-headers.cc.

References m_startingSeq, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by IsFragmentReceived(), IsPacketReceived(), SetReceivedFragment(), and SetReceivedPacket().

Here is the caller graph for this function:

bool ns3::CtrlBAckResponseHeader::IsBasic ( void ) const

Definition at line 468 of file ctrl-headers.cc.

References m_compressed, m_multiTid, and NS_LOG_FUNCTION.

Referenced by ns3::BlockAckCache::FillBlockAckBitmap(), ns3::BlockAckManager::NotifyGotBlockAck(), and ns3::MacLow::SendBlockAckResponse().

Here is the caller graph for this function:

bool ns3::CtrlBAckResponseHeader::IsCompressed ( void ) const

Definition at line 475 of file ctrl-headers.cc.

References m_compressed, m_multiTid, and NS_LOG_FUNCTION.

Referenced by ns3::BlockAckCache::FillBlockAckBitmap(), ns3::BlockAckManager::NotifyGotBlockAck(), and ns3::MacLow::SendBlockAckResponse().

Here is the caller graph for this function:

bool ns3::CtrlBAckResponseHeader::IsFragmentReceived	(	uint16_t	seq,
		uint8_t	frag
	)		const

Definition at line 703 of file ctrl-headers.cc.

References bitmap, IndexInBitmap(), IsInBitmap(), m_compressed, m_multiTid, NS_ASSERT, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Referenced by ns3::BlockAckManager::NotifyGotBlockAck().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::CtrlBAckResponseHeader::IsInBitmap ( uint16_t seq ) const

private

Checks if sequence number seq can be acknowledged in the bitmap.

Parameters

seq	the sequence number

Returns

Definition at line 758 of file ctrl-headers.cc.

References m_startingSeq, and NS_LOG_FUNCTION.

Referenced by IsFragmentReceived(), IsPacketReceived(), SetReceivedFragment(), and SetReceivedPacket().

Here is the caller graph for this function:

bool ns3::CtrlBAckResponseHeader::IsMultiTid ( void ) const

Definition at line 482 of file ctrl-headers.cc.

References m_compressed, m_multiTid, and NS_LOG_FUNCTION.

Referenced by ns3::BlockAckCache::FillBlockAckBitmap(), ns3::BlockAckManager::NotifyGotBlockAck(), and ns3::MacLow::SendBlockAckResponse().

Here is the caller graph for this function:

bool ns3::CtrlBAckResponseHeader::IsPacketReceived ( uint16_t seq ) const

Definition at line 668 of file ctrl-headers.cc.

References bitmap, IndexInBitmap(), IsInBitmap(), m_compressed, m_multiTid, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Referenced by CtrlBAckResponseHeaderTest::DoRun(), and ns3::BlockAckManager::NotifyGotBlockAck().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::CtrlBAckResponseHeader::MustSendHtImmediateAck ( void ) const

Definition at line 446 of file ctrl-headers.cc.

References m_baAckPolicy, and NS_LOG_FUNCTION.

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

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

Definition at line 314 of file ctrl-headers.cc.

References m_startingSeq, m_tidInfo, and NS_LOG_FUNCTION.

void ns3::CtrlBAckResponseHeader::ResetBitmap ( void )

Definition at line 779 of file ctrl-headers.cc.

References bitmap, and NS_LOG_FUNCTION.

Referenced by CtrlBAckResponseHeaderTest::DoRun().

Here is the caller graph for this function:

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

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.

Implements ns3::Header.

Definition at line 352 of file ctrl-headers.cc.

References GetBaControl(), GetStartingSequenceControl(), m_compressed, m_multiTid, NS_FATAL_ERROR, NS_LOG_FUNCTION, SerializeBitmap(), visualizer.core::start(), and ns3::Buffer::Iterator::WriteHtolsbU16().

Here is the call graph for this function:

Buffer::Iterator ns3::CtrlBAckResponseHeader::SerializeBitmap ( Buffer::Iterator start ) const

private

Definition at line 534 of file ctrl-headers.cc.

References bitmap, m_compressed, m_multiTid, NS_FATAL_ERROR, NS_LOG_FUNCTION, visualizer.core::start(), ns3::Buffer::Iterator::WriteHtolsbU16(), and ns3::Buffer::Iterator::WriteHtolsbU64().

Referenced by Serialize().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::CtrlBAckResponseHeader::SetBaControl ( uint16_t bar )

private

Definition at line 510 of file ctrl-headers.cc.

References m_baAckPolicy, m_compressed, m_multiTid, m_tidInfo, and NS_LOG_FUNCTION.

Referenced by Deserialize().

Here is the caller graph for this function:

void ns3::CtrlBAckResponseHeader::SetHtImmediateAck ( bool immeadiateAck )

Definition at line 401 of file ctrl-headers.cc.

References m_baAckPolicy, and NS_LOG_FUNCTION.

void ns3::CtrlBAckResponseHeader::SetReceivedFragment	(	uint16_t	seq,
		uint8_t	frag
	)

Definition at line 634 of file ctrl-headers.cc.

References bitmap, IndexInBitmap(), IsInBitmap(), m_compressed, m_multiTid, NS_ASSERT, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Here is the call graph for this function:

void ns3::CtrlBAckResponseHeader::SetReceivedPacket ( uint16_t seq )

Definition at line 600 of file ctrl-headers.cc.

References bitmap, IndexInBitmap(), IsInBitmap(), m_compressed, m_multiTid, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Referenced by CtrlBAckResponseHeaderTest::DoRun(), and ns3::BlockAckCache::FillBlockAckBitmap().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::CtrlBAckResponseHeader::SetStartingSequence ( uint16_t seq )

Definition at line 439 of file ctrl-headers.cc.

References m_startingSeq, and NS_LOG_FUNCTION.

Referenced by CtrlBAckResponseHeaderTest::DoRun(), and ns3::MacLow::SendBlockAckAfterBlockAckRequest().

Here is the caller graph for this function:

void ns3::CtrlBAckResponseHeader::SetStartingSequenceControl ( uint16_t seqControl )

Definition at line 527 of file ctrl-headers.cc.

References m_startingSeq, and NS_LOG_FUNCTION.

Referenced by Deserialize().

Here is the caller graph for this function:

void ns3::CtrlBAckResponseHeader::SetTidInfo ( uint8_t tid )

Definition at line 432 of file ctrl-headers.cc.

References m_tidInfo, and NS_LOG_FUNCTION.

Referenced by ns3::MacLow::SendBlockAckAfterBlockAckRequest().

Here is the caller graph for this function:

void ns3::CtrlBAckResponseHeader::SetType ( enum BlockAckType type )

Definition at line 408 of file ctrl-headers.cc.

References ns3::BASIC_BLOCK_ACK, ns3::COMPRESSED_BLOCK_ACK, m_compressed, m_multiTid, ns3::MULTI_TID_BLOCK_ACK, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Referenced by CtrlBAckResponseHeaderTest::DoRun(), ns3::MacLow::GetBlockAckSize(), and ns3::MacLow::SendBlockAckAfterBlockAckRequest().

Here is the caller graph for this function:

Member Data Documentation

union { ... } ns3::CtrlBAckResponseHeader::bitmap

Referenced by CtrlBAckResponseHeader(), DeserializeBitmap(), GetBitmap(), GetCompressedBitmap(), IsFragmentReceived(), IsPacketReceived(), ResetBitmap(), SerializeBitmap(), SetReceivedFragment(), and SetReceivedPacket().

bool ns3::CtrlBAckResponseHeader::m_baAckPolicy

private

The lsb bit of the BA control field is used only for the HT (High Throughput) delayed block ack configuration. For now only non HT immediate block ack is implemented so this field is here only for a future implementation of HT delayed variant.

Definition at line 176 of file ctrl-headers.h.

Referenced by GetBaControl(), MustSendHtImmediateAck(), SetBaControl(), and SetHtImmediateAck().

uint16_t ns3::CtrlBAckResponseHeader::m_bitmap[64]

Definition at line 184 of file ctrl-headers.h.

bool ns3::CtrlBAckResponseHeader::m_compressed

private

Definition at line 178 of file ctrl-headers.h.

Referenced by Deserialize(), DeserializeBitmap(), GetBaControl(), GetSerializedSize(), IsBasic(), IsCompressed(), IsFragmentReceived(), IsMultiTid(), IsPacketReceived(), Serialize(), SerializeBitmap(), SetBaControl(), SetReceivedFragment(), SetReceivedPacket(), and SetType().