Headers for BlockAck response. More...
#include "ctrl-headers.h"
Public Member Functions | |
CtrlBAckResponseHeader () | |
~CtrlBAckResponseHeader () | |
uint32_t | Deserialize (Buffer::Iterator start) |
const std::vector< uint8_t > & | GetBitmap (void) const |
Return a const reference to the bitmap from the BlockAck response header. More... | |
TypeId | GetInstanceTypeId (void) const |
Get the most derived TypeId for this Object. More... | |
uint32_t | GetSerializedSize (void) const |
uint16_t | GetStartingSequence (void) const |
Return the starting sequence number. More... | |
uint16_t | GetStartingSequenceControl (void) const |
Return the starting sequence control. More... | |
uint8_t | GetTidInfo (void) const |
Return the Traffic ID (TID). More... | |
BlockAckType | GetType (void) const |
Return the block ack type ID. More... | |
bool | IsBasic (void) const |
Check if the current BA policy is Basic Block Ack. More... | |
bool | IsCompressed (void) const |
Check if the current BA policy is Compressed Block Ack. More... | |
bool | IsExtendedCompressed (void) const |
Check if the current BA policy is Extended Compressed Block Ack. More... | |
bool | IsFragmentReceived (uint16_t seq, uint8_t frag) const |
Check if the packet with the given sequence number and fragment number was acknowledged in this BlockAck response. More... | |
bool | IsMultiTid (void) const |
Check if the current BA policy is Multi-TID Block Ack. More... | |
bool | IsPacketReceived (uint16_t seq) const |
Check if the packet with the given sequence number was acknowledged in this BlockAck response. More... | |
bool | MustSendHtImmediateAck (void) const |
Check if the current Ack Policy is immediate. More... | |
void | Print (std::ostream &os) const |
void | ResetBitmap (void) |
Reset the bitmap to 0. More... | |
void | Serialize (Buffer::Iterator start) const |
void | SetHtImmediateAck (bool immediateAck) |
Enable or disable HT immediate Ack. More... | |
void | SetReceivedFragment (uint16_t seq, uint8_t frag) |
Set the bitmap that the packet with the given sequence number and fragment number was received. More... | |
void | SetReceivedPacket (uint16_t seq) |
Set the bitmap that the packet with the given sequence number was received. More... | |
void | SetStartingSequence (uint16_t seq) |
Set the starting sequence number from the given raw sequence control field. More... | |
void | SetStartingSequenceControl (uint16_t seqControl) |
Set the starting sequence control with the given sequence control value. More... | |
void | SetTidInfo (uint8_t tid) |
Set Traffic ID (TID). More... | |
void | SetType (BlockAckType type) |
Set the block ack type. More... | |
![]() | |
virtual | ~Header () |
virtual uint32_t | Deserialize (Buffer::Iterator start, Buffer::Iterator end) |
Deserialize the object from a buffer iterator. More... | |
virtual uint32_t | Deserialize (Buffer::Iterator start)=0 |
Deserialize the object from a buffer iterator. More... | |
![]() | |
virtual uint32_t | Deserialize (Buffer::Iterator start, Buffer::Iterator end) |
Deserialize the object from a buffer iterator. More... | |
![]() | |
virtual | ~ObjectBase () |
Virtual destructor. More... | |
void | GetAttribute (std::string name, AttributeValue &value) const |
Get the value of an attribute, raising fatal errors if unsuccessful. More... | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising erros. More... | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. More... | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. More... | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. More... | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. More... | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. More... | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. More... | |
Static Public Member Functions | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
![]() | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
![]() | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
![]() | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Private Member Functions | |
Buffer::Iterator | DeserializeBitmap (Buffer::Iterator start) |
Deserialize bitmap from the given buffer. More... | |
uint16_t | GetBaControl (void) const |
Return the Block Ack control. More... | |
uint16_t | IndexInBitmap (uint16_t seq) const |
This function is used to correctly index in both bitmap and compressed bitmap, one bit or one block of 16 bits respectively. More... | |
bool | IsInBitmap (uint16_t seq) const |
Checks if sequence number seq can be acknowledged in the bitmap. More... | |
Buffer::Iterator | SerializeBitmap (Buffer::Iterator start) const |
Serialize bitmap to the given buffer. More... | |
void | SetBaControl (uint16_t ba) |
Set the Block Ack control. More... | |
Private Attributes | |
bool | m_baAckPolicy |
The LSB bit of the BA control field is used only for the HT (High Throughput) delayed block ack configuration. More... | |
BlockAckType | m_baType |
BA type. More... | |
std::vector< uint8_t > | m_bitmap |
block ack bitmap More... | |
uint16_t | m_startingSeq |
starting seq More... | |
uint16_t | m_tidInfo |
TID info. More... | |
Additional Inherited Members | |
![]() | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. More... | |
virtual void | NotifyConstructionCompleted (void) |
Notifier called once the ObjectBase is fully constructed. More... | |
![]() | |
static TypeId | GetObjectIid (void) |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
Headers for BlockAck response.
Introspection did not find any typical Config paths.
802.11n standard includes three types of BlockAck:
No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 80 bytes (on a 64-bit architecture).
Definition at line 194 of file ctrl-headers.h.
ns3::CtrlBAckResponseHeader::CtrlBAckResponseHeader | ( | ) |
Definition at line 271 of file ctrl-headers.cc.
References ns3::BlockAckType::BASIC, and SetType().
ns3::CtrlBAckResponseHeader::~CtrlBAckResponseHeader | ( | ) |
Definition at line 279 of file ctrl-headers.cc.
|
virtual |
start | an iterator which points to where the header should read from. |
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 351 of file ctrl-headers.cc.
References ns3::BlockAckType::BASIC, ns3::BlockAckType::COMPRESSED, DeserializeBitmap(), ns3::BlockAckType::EXTENDED_COMPRESSED, ns3::Buffer::Iterator::GetDistanceFrom(), m_baType, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_TID, NS_FATAL_ERROR, ns3::Buffer::Iterator::ReadLsbtohU16(), SetBaControl(), SetStartingSequenceControl(), and visualizer.core::start().
|
private |
Deserialize bitmap from the given buffer.
start | the iterator |
Definition at line 567 of file ctrl-headers.cc.
References ns3::BlockAckType::BASIC, ns3::BlockAckType::COMPRESSED, ns3::BlockAckType::EXTENDED_COMPRESSED, m_baType, m_bitmap, ns3::BlockAckType::m_bitmapLen, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_TID, NS_FATAL_ERROR, ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().
Referenced by Deserialize().
|
private |
Return the Block Ack control.
Definition at line 449 of file ctrl-headers.cc.
References ns3::BlockAckType::BASIC, ns3::BlockAckType::COMPRESSED, ns3::BlockAckType::EXTENDED_COMPRESSED, m_baAckPolicy, m_baType, m_tidInfo, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_TID, and NS_FATAL_ERROR.
Referenced by Serialize().
const std::vector< uint8_t > & ns3::CtrlBAckResponseHeader::GetBitmap | ( | void | ) | const |
Return a const reference to the bitmap from the BlockAck response header.
Definition at line 744 of file ctrl-headers.cc.
References m_bitmap.
Referenced by CtrlBAckResponseHeaderTest::DoRun().
|
virtual |
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.
Implements ns3::ObjectBase.
Definition at line 295 of file ctrl-headers.cc.
References GetTypeId().
|
virtual |
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 307 of file ctrl-headers.cc.
References ns3::BlockAckType::BASIC, ns3::BlockAckType::COMPRESSED, ns3::BlockAckType::EXTENDED_COMPRESSED, m_baType, ns3::BlockAckType::m_bitmapLen, m_tidInfo, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_TID, and NS_FATAL_ERROR.
Referenced by ns3::GetBlockAckSize().
uint16_t ns3::CtrlBAckResponseHeader::GetStartingSequence | ( | void | ) | const |
Return the starting sequence number.
Definition at line 419 of file ctrl-headers.cc.
References m_startingSeq.
uint16_t ns3::CtrlBAckResponseHeader::GetStartingSequenceControl | ( | void | ) | const |
Return the starting sequence control.
Definition at line 505 of file ctrl-headers.cc.
References ns3::BlockAckType::COMPRESSED, m_baType, ns3::BlockAckType::m_bitmapLen, m_startingSeq, and ns3::BlockAckType::m_variant.
Referenced by Serialize().
uint8_t ns3::CtrlBAckResponseHeader::GetTidInfo | ( | void | ) | const |
Return the Traffic ID (TID).
Definition at line 412 of file ctrl-headers.cc.
References m_tidInfo.
Referenced by ns3::GetTid(), ns3::BlockAckManager::NotifyGotBlockAck(), and ns3::HtFrameExchangeManager::ReceiveMpdu().
BlockAckType ns3::CtrlBAckResponseHeader::GetType | ( | void | ) | const |
Return the block ack type ID.
Definition at line 388 of file ctrl-headers.cc.
References m_baType.
|
static |
Get the type ID.
Definition at line 284 of file ctrl-headers.cc.
References ns3::TypeId::SetParent().
Referenced by GetInstanceTypeId().
|
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
seq | the sequence number |
Definition at line 708 of file ctrl-headers.cc.
References ns3::BlockAckType::COMPRESSED, m_baType, ns3::BlockAckType::m_bitmapLen, m_startingSeq, ns3::BlockAckType::m_variant, NS_ASSERT, and ns3::SEQNO_SPACE_SIZE.
Referenced by IsFragmentReceived(), IsPacketReceived(), SetReceivedFragment(), and SetReceivedPacket().
bool ns3::CtrlBAckResponseHeader::IsBasic | ( | void | ) | const |
Check if the current BA policy is Basic Block Ack.
Definition at line 425 of file ctrl-headers.cc.
References ns3::BlockAckType::BASIC, m_baType, and ns3::BlockAckType::m_variant.
Referenced by ns3::RecipientBlockAckAgreement::FillBlockAckBitmap(), and ns3::BlockAckManager::NotifyGotBlockAck().
bool ns3::CtrlBAckResponseHeader::IsCompressed | ( | void | ) | const |
Check if the current BA policy is Compressed Block Ack.
Definition at line 431 of file ctrl-headers.cc.
References ns3::BlockAckType::COMPRESSED, m_baType, and ns3::BlockAckType::m_variant.
Referenced by ns3::RecipientBlockAckAgreement::FillBlockAckBitmap(), and ns3::BlockAckManager::NotifyGotBlockAck().
bool ns3::CtrlBAckResponseHeader::IsExtendedCompressed | ( | void | ) | const |
Check if the current BA policy is Extended Compressed Block Ack.
Definition at line 437 of file ctrl-headers.cc.
References ns3::BlockAckType::EXTENDED_COMPRESSED, m_baType, and ns3::BlockAckType::m_variant.
Referenced by ns3::RecipientBlockAckAgreement::FillBlockAckBitmap(), and ns3::BlockAckManager::NotifyGotBlockAck().
bool ns3::CtrlBAckResponseHeader::IsFragmentReceived | ( | uint16_t | seq, |
uint8_t | frag | ||
) | const |
Check if the packet with the given sequence number and fragment number was acknowledged in this BlockAck response.
seq | the sequence number |
frag | the fragment number |
Definition at line 677 of file ctrl-headers.cc.
References ns3::BlockAckType::BASIC, ns3::BlockAckType::COMPRESSED, ns3::BlockAckType::EXTENDED_COMPRESSED, IndexInBitmap(), IsInBitmap(), m_baType, m_bitmap, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_TID, NS_ASSERT, and NS_FATAL_ERROR.
Referenced by ns3::BlockAckManager::NotifyGotBlockAck().
|
private |
Checks if sequence number seq can be acknowledged in the bitmap.
seq | the sequence number |
Definition at line 731 of file ctrl-headers.cc.
References ns3::BlockAckType::COMPRESSED, m_baType, ns3::BlockAckType::m_bitmapLen, m_startingSeq, ns3::BlockAckType::m_variant, and ns3::SEQNO_SPACE_SIZE.
Referenced by IsFragmentReceived(), IsPacketReceived(), SetReceivedFragment(), and SetReceivedPacket().
bool ns3::CtrlBAckResponseHeader::IsMultiTid | ( | void | ) | const |
Check if the current BA policy is Multi-TID Block Ack.
Definition at line 443 of file ctrl-headers.cc.
References m_baType, ns3::BlockAckType::m_variant, and ns3::BlockAckType::MULTI_TID.
Referenced by ns3::RecipientBlockAckAgreement::FillBlockAckBitmap(), and ns3::BlockAckManager::NotifyGotBlockAck().
bool ns3::CtrlBAckResponseHeader::IsPacketReceived | ( | uint16_t | seq | ) | const |
Check if the packet with the given sequence number was acknowledged in this BlockAck response.
seq | the sequence number |
Definition at line 648 of file ctrl-headers.cc.
References ns3::BlockAckType::BASIC, ns3::BlockAckType::COMPRESSED, ns3::BlockAckType::EXTENDED_COMPRESSED, IndexInBitmap(), IsInBitmap(), m_baType, m_bitmap, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_TID, and NS_FATAL_ERROR.
Referenced by CtrlBAckResponseHeaderTest::DoRun(), and ns3::BlockAckManager::NotifyGotBlockAck().
bool ns3::CtrlBAckResponseHeader::MustSendHtImmediateAck | ( | void | ) | const |
Check if the current Ack Policy is immediate.
Definition at line 406 of file ctrl-headers.cc.
References m_baAckPolicy.
|
virtual |
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 301 of file ctrl-headers.cc.
References m_startingSeq, and m_tidInfo.
void ns3::CtrlBAckResponseHeader::ResetBitmap | ( | void | ) |
Reset the bitmap to 0.
Definition at line 750 of file ctrl-headers.cc.
References m_baType, m_bitmap, and ns3::BlockAckType::m_bitmapLen.
Referenced by CtrlBAckResponseHeaderTest::DoRun(), and ns3::RecipientBlockAckAgreement::FillBlockAckBitmap().
|
virtual |
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 329 of file ctrl-headers.cc.
References ns3::BlockAckType::BASIC, ns3::BlockAckType::COMPRESSED, ns3::BlockAckType::EXTENDED_COMPRESSED, GetBaControl(), GetStartingSequenceControl(), m_baType, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_TID, NS_FATAL_ERROR, SerializeBitmap(), visualizer.core::start(), and ns3::Buffer::Iterator::WriteHtolsbU16().
|
private |
Serialize bitmap to the given buffer.
start | the iterator |
Definition at line 543 of file ctrl-headers.cc.
References ns3::BlockAckType::BASIC, ns3::BlockAckType::COMPRESSED, ns3::BlockAckType::EXTENDED_COMPRESSED, m_baType, m_bitmap, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_TID, NS_FATAL_ERROR, visualizer.core::start(), and ns3::Buffer::Iterator::WriteU8().
Referenced by Serialize().
|
private |
Set the Block Ack control.
ba | the BA control to set |
Definition at line 478 of file ctrl-headers.cc.
References ns3::BlockAckType::BASIC, ns3::BlockAckType::COMPRESSED, ns3::BlockAckType::EXTENDED_COMPRESSED, m_baAckPolicy, m_tidInfo, ns3::BlockAckType::MULTI_TID, NS_FATAL_ERROR, and SetType().
Referenced by Deserialize().
void ns3::CtrlBAckResponseHeader::SetHtImmediateAck | ( | bool | immediateAck | ) |
Enable or disable HT immediate Ack.
immediateAck | enable or disable HT immediate Ack |
Definition at line 374 of file ctrl-headers.cc.
References m_baAckPolicy.
void ns3::CtrlBAckResponseHeader::SetReceivedFragment | ( | uint16_t | seq, |
uint8_t | frag | ||
) |
Set the bitmap that the packet with the given sequence number and fragment number was received.
seq | the sequence number |
frag | the fragment number |
Definition at line 621 of file ctrl-headers.cc.
References ns3::BlockAckType::BASIC, ns3::BlockAckType::COMPRESSED, ns3::BlockAckType::EXTENDED_COMPRESSED, IndexInBitmap(), IsInBitmap(), m_baType, m_bitmap, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_TID, NS_ASSERT, and NS_FATAL_ERROR.
void ns3::CtrlBAckResponseHeader::SetReceivedPacket | ( | uint16_t | seq | ) |
Set the bitmap that the packet with the given sequence number was received.
seq | the sequence number |
Definition at line 591 of file ctrl-headers.cc.
References ns3::BlockAckType::BASIC, ns3::BlockAckType::COMPRESSED, ns3::BlockAckType::EXTENDED_COMPRESSED, IndexInBitmap(), IsInBitmap(), m_baType, m_bitmap, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_TID, and NS_FATAL_ERROR.
Referenced by CtrlBAckResponseHeaderTest::DoRun(), and ns3::RecipientBlockAckAgreement::FillBlockAckBitmap().
void ns3::CtrlBAckResponseHeader::SetStartingSequence | ( | uint16_t | seq | ) |
Set the starting sequence number from the given raw sequence control field.
seq | the raw sequence control |
Definition at line 400 of file ctrl-headers.cc.
References m_startingSeq.
Referenced by CtrlBAckResponseHeaderTest::DoRun(), and ns3::RecipientBlockAckAgreement::FillBlockAckBitmap().
void ns3::CtrlBAckResponseHeader::SetStartingSequenceControl | ( | uint16_t | seqControl | ) |
Set the starting sequence control with the given sequence control value.
seqControl | the raw sequence control value |
Definition at line 518 of file ctrl-headers.cc.
References ns3::BlockAckType::COMPRESSED, m_baType, m_startingSeq, ns3::BlockAckType::m_variant, NS_FATAL_ERROR, and SetType().
Referenced by Deserialize().
void ns3::CtrlBAckResponseHeader::SetTidInfo | ( | uint8_t | tid | ) |
Set Traffic ID (TID).
tid | the TID |
Definition at line 394 of file ctrl-headers.cc.
References m_tidInfo.
Referenced by ns3::HtFrameExchangeManager::SendBlockAck().
void ns3::CtrlBAckResponseHeader::SetType | ( | BlockAckType | type | ) |
Set the block ack type.
type | the BA type |
Definition at line 380 of file ctrl-headers.cc.
References m_baType, m_bitmap, and ns3::BlockAckType::m_bitmapLen.
Referenced by CtrlBAckResponseHeader(), CtrlBAckResponseHeaderTest::DoRun(), ns3::GetBlockAckSize(), ns3::HtFrameExchangeManager::SendBlockAck(), SetBaControl(), and SetStartingSequenceControl().
|
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.BA Ack Policy
Definition at line 412 of file ctrl-headers.h.
Referenced by GetBaControl(), MustSendHtImmediateAck(), SetBaControl(), and SetHtImmediateAck().
|
private |
BA type.
Definition at line 413 of file ctrl-headers.h.
Referenced by Deserialize(), DeserializeBitmap(), GetBaControl(), GetSerializedSize(), GetStartingSequenceControl(), GetType(), IndexInBitmap(), IsBasic(), IsCompressed(), IsExtendedCompressed(), IsFragmentReceived(), IsInBitmap(), IsMultiTid(), IsPacketReceived(), ResetBitmap(), Serialize(), SerializeBitmap(), SetReceivedFragment(), SetReceivedPacket(), SetStartingSequenceControl(), and SetType().
|
private |
block ack bitmap
Definition at line 416 of file ctrl-headers.h.
Referenced by DeserializeBitmap(), GetBitmap(), IsFragmentReceived(), IsPacketReceived(), ResetBitmap(), SerializeBitmap(), SetReceivedFragment(), SetReceivedPacket(), and SetType().
|
private |
starting seq
Definition at line 415 of file ctrl-headers.h.
Referenced by GetStartingSequence(), GetStartingSequenceControl(), IndexInBitmap(), IsInBitmap(), Print(), SetStartingSequence(), and SetStartingSequenceControl().
|
private |
TID info.
Definition at line 414 of file ctrl-headers.h.
Referenced by GetBaControl(), GetSerializedSize(), GetTidInfo(), Print(), SetBaControl(), and SetTidInfo().