Headers for Block ack response. More...
#include "ctrl-headers.h"
Public Member Functions | |
CtrlBAckResponseHeader () | |
~CtrlBAckResponseHeader () | |
uint32_t | Deserialize (Buffer::Iterator start) |
const uint16_t * | GetBitmap (void) const |
Return the bitmap from the block ACK response header. More... | |
uint64_t | GetCompressedBitmap (void) const |
Return the compressed bitmap from the block ACK 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... | |
bool | IsBasic (void) const |
Check if the current ACK policy is basic (i.e. More... | |
bool | IsCompressed (void) const |
Check if the current ACK policy is compressed ACK and not multiple TID. More... | |
bool | IsFragmentReceived (uint16_t seq, uint8_t frag) const |
Check if the packet with the given sequence number and fragment number was ACKed in this Block ACK response. More... | |
bool | IsMultiTid (void) const |
Check if the current ACK policy has multiple TID. More... | |
bool | IsPacketReceived (uint16_t seq) const |
Check if the packet with the given sequence number was ACKed in this Block ACK 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... | |
Public Member Functions inherited from ns3::Header | |
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... | |
Public Member Functions inherited from ns3::Chunk | |
virtual uint32_t | Deserialize (Buffer::Iterator start, Buffer::Iterator end) |
Deserialize the object from a buffer iterator. More... | |
Public Member Functions inherited from ns3::ObjectBase | |
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 Public Member Functions inherited from ns3::Header | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Static Public Member Functions inherited from ns3::Chunk | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Static Public Member Functions inherited from ns3::ObjectBase | |
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 bar) |
Set the block ACK control. More... | |
Private Attributes | |
union { | |
uint16_t m_bitmap [64] | |
the block ack bitmap More... | |
uint64_t m_compressedBitmap | |
the compressed block ack bitmap More... | |
} | bitmap |
bitmap union type More... | |
bool | m_baAckPolicy |
The lsb bit of the BA control field is used only for the HT (High Throughput) delayed block ack configuration. More... | |
bool | m_compressed |
compressed More... | |
bool | m_multiTid |
multi TID More... | |
uint16_t | m_startingSeq |
starting seq More... | |
uint16_t | m_tidInfo |
TID info. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::ObjectBase | |
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... | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid (void) |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
Headers for Block ack response.
Introspection did not find any typical Config paths.
802.11n standard includes three types of block ack:
No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 144 bytes (on a 64-bit architecture).
Definition at line 181 of file ctrl-headers.h.
ns3::CtrlBAckResponseHeader::CtrlBAckResponseHeader | ( | ) |
Definition at line 251 of file ctrl-headers.cc.
References bitmap.
ns3::CtrlBAckResponseHeader::~CtrlBAckResponseHeader | ( | ) |
Definition at line 259 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 337 of file ctrl-headers.cc.
References DeserializeBitmap(), ns3::Buffer::Iterator::GetDistanceFrom(), m_compressed, m_multiTid, NS_FATAL_ERROR, ns3::Buffer::Iterator::ReadLsbtohU16(), SetBaControl(), SetStartingSequenceControl(), and visualizer.core::start().
|
private |
Deserialize bitmap from the given buffer.
start |
Definition at line 509 of file ctrl-headers.cc.
References bitmap, m_compressed, m_multiTid, NS_FATAL_ERROR, ns3::Buffer::Iterator::ReadLsbtohU16(), ns3::Buffer::Iterator::ReadLsbtohU64(), and visualizer.core::start().
Referenced by Deserialize().
|
private |
Return the block ACK control.
Definition at line 436 of file ctrl-headers.cc.
References m_baAckPolicy, m_compressed, m_multiTid, and m_tidInfo.
Referenced by Serialize().
const uint16_t * ns3::CtrlBAckResponseHeader::GetBitmap | ( | void | ) | const |
Return the bitmap from the block ACK response header.
Definition at line 700 of file ctrl-headers.cc.
References bitmap.
uint64_t ns3::CtrlBAckResponseHeader::GetCompressedBitmap | ( | void | ) | const |
Return the compressed bitmap from the block ACK response header.
Definition at line 706 of file ctrl-headers.cc.
References 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 275 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 287 of file ctrl-headers.cc.
References m_compressed, m_multiTid, m_tidInfo, and NS_FATAL_ERROR.
Referenced by ns3::GetBlockAckSize().
uint16_t ns3::CtrlBAckResponseHeader::GetStartingSequence | ( | void | ) | const |
Return the starting sequence number.
Definition at line 412 of file ctrl-headers.cc.
References m_startingSeq.
Referenced by ns3::BlockAckCache::FillBlockAckBitmap().
uint16_t ns3::CtrlBAckResponseHeader::GetStartingSequenceControl | ( | void | ) | const |
Return the starting sequence control.
Definition at line 465 of file ctrl-headers.cc.
References m_startingSeq.
Referenced by Serialize().
uint8_t ns3::CtrlBAckResponseHeader::GetTidInfo | ( | void | ) | const |
Return the Traffic ID (TID).
Definition at line 405 of file ctrl-headers.cc.
References m_tidInfo.
Referenced by ns3::GetTid(), ns3::QosTxop::NeedBarRetransmission(), and ns3::BlockAckManager::NotifyGotBlockAck().
|
static |
Get the type ID.
Definition at line 264 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 678 of file ctrl-headers.cc.
References m_startingSeq, and NS_ASSERT.
Referenced by IsFragmentReceived(), IsPacketReceived(), SetReceivedFragment(), and SetReceivedPacket().
bool ns3::CtrlBAckResponseHeader::IsBasic | ( | void | ) | const |
Check if the current ACK policy is basic (i.e.
not multiple TID and not compressed ACK).
Definition at line 418 of file ctrl-headers.cc.
References m_compressed, and m_multiTid.
Referenced by ns3::BlockAckCache::FillBlockAckBitmap(), ns3::BlockAckManager::NotifyGotBlockAck(), and ns3::MacLow::SendBlockAckResponse().
bool ns3::CtrlBAckResponseHeader::IsCompressed | ( | void | ) | const |
Check if the current ACK policy is compressed ACK and not multiple TID.
Definition at line 424 of file ctrl-headers.cc.
References m_compressed, and m_multiTid.
Referenced by ns3::BlockAckCache::FillBlockAckBitmap(), ns3::BlockAckManager::NotifyGotBlockAck(), and ns3::MacLow::SendBlockAckResponse().
bool ns3::CtrlBAckResponseHeader::IsFragmentReceived | ( | uint16_t | seq, |
uint8_t | frag | ||
) | const |
Check if the packet with the given sequence number and fragment number was ACKed in this Block ACK response.
seq | |
frag |
Definition at line 641 of file ctrl-headers.cc.
References bitmap, IndexInBitmap(), IsInBitmap(), m_compressed, m_multiTid, 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 694 of file ctrl-headers.cc.
References m_startingSeq.
Referenced by IsFragmentReceived(), IsPacketReceived(), SetReceivedFragment(), and SetReceivedPacket().
bool ns3::CtrlBAckResponseHeader::IsMultiTid | ( | void | ) | const |
Check if the current ACK policy has multiple TID.
Definition at line 430 of file ctrl-headers.cc.
References m_compressed, and m_multiTid.
Referenced by ns3::BlockAckCache::FillBlockAckBitmap(), ns3::BlockAckManager::NotifyGotBlockAck(), and ns3::MacLow::SendBlockAckResponse().
bool ns3::CtrlBAckResponseHeader::IsPacketReceived | ( | uint16_t | seq | ) | const |
Check if the packet with the given sequence number was ACKed in this Block ACK response.
seq |
Definition at line 607 of file ctrl-headers.cc.
References bitmap, IndexInBitmap(), IsInBitmap(), m_compressed, m_multiTid, 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 399 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 281 of file ctrl-headers.cc.
References m_startingSeq, and m_tidInfo.
void ns3::CtrlBAckResponseHeader::ResetBitmap | ( | void | ) |
Reset the bitmap to 0.
Definition at line 712 of file ctrl-headers.cc.
References bitmap.
Referenced by CtrlBAckResponseHeaderTest::DoRun().
|
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 317 of file ctrl-headers.cc.
References GetBaControl(), GetStartingSequenceControl(), m_compressed, m_multiTid, NS_FATAL_ERROR, SerializeBitmap(), visualizer.core::start(), and ns3::Buffer::Iterator::WriteHtolsbU16().
|
private |
Serialize bitmap to the given buffer.
start |
Definition at line 477 of file ctrl-headers.cc.
References bitmap, m_compressed, m_multiTid, NS_FATAL_ERROR, visualizer.core::start(), ns3::Buffer::Iterator::WriteHtolsbU16(), and ns3::Buffer::Iterator::WriteHtolsbU64().
Referenced by Serialize().
|
private |
Set the block ACK control.
bar |
Definition at line 456 of file ctrl-headers.cc.
References m_baAckPolicy, m_compressed, m_multiTid, and m_tidInfo.
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 358 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 | |
frag |
Definition at line 574 of file ctrl-headers.cc.
References bitmap, IndexInBitmap(), IsInBitmap(), m_compressed, m_multiTid, 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 |
Definition at line 541 of file ctrl-headers.cc.
References bitmap, IndexInBitmap(), IsInBitmap(), m_compressed, m_multiTid, and NS_FATAL_ERROR.
Referenced by CtrlBAckResponseHeaderTest::DoRun(), and ns3::BlockAckCache::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 393 of file ctrl-headers.cc.
References m_startingSeq.
Referenced by CtrlBAckResponseHeaderTest::DoRun(), and ns3::MacLow::SendBlockAckAfterBlockAckRequest().
void ns3::CtrlBAckResponseHeader::SetStartingSequenceControl | ( | uint16_t | seqControl | ) |
Set the starting sequence control with the given sequence control value.
seqControl |
Definition at line 471 of file ctrl-headers.cc.
References m_startingSeq.
Referenced by Deserialize().
void ns3::CtrlBAckResponseHeader::SetTidInfo | ( | uint8_t | tid | ) |
Set Traffic ID (TID).
tid |
Definition at line 387 of file ctrl-headers.cc.
References m_tidInfo.
Referenced by ns3::MacLow::SendBlockAckAfterBlockAckRequest().
void ns3::CtrlBAckResponseHeader::SetType | ( | BlockAckType | type | ) |
Set the block ACK type.
type |
Definition at line 364 of file ctrl-headers.cc.
References ns3::BASIC_BLOCK_ACK, ns3::COMPRESSED_BLOCK_ACK, m_compressed, m_multiTid, ns3::MULTI_TID_BLOCK_ACK, and NS_FATAL_ERROR.
Referenced by CtrlBAckResponseHeaderTest::DoRun(), ns3::GetBlockAckSize(), and ns3::MacLow::SendBlockAckAfterBlockAckRequest().
union { ... } ns3::CtrlBAckResponseHeader::bitmap |
bitmap union type
Referenced by CtrlBAckResponseHeader(), DeserializeBitmap(), GetBitmap(), GetCompressedBitmap(), IsFragmentReceived(), IsPacketReceived(), ResetBitmap(), SerializeBitmap(), SetReceivedFragment(), and SetReceivedPacket().
|
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 394 of file ctrl-headers.h.
Referenced by GetBaControl(), MustSendHtImmediateAck(), SetBaControl(), and SetHtImmediateAck().
uint16_t ns3::CtrlBAckResponseHeader::m_bitmap[64] |
the block ack bitmap
Definition at line 402 of file ctrl-headers.h.
|
private |
compressed
Definition at line 396 of file ctrl-headers.h.
Referenced by Deserialize(), DeserializeBitmap(), GetBaControl(), GetSerializedSize(), IsBasic(), IsCompressed(), IsFragmentReceived(), IsMultiTid(), IsPacketReceived(), Serialize(), SerializeBitmap(), SetBaControl(), SetReceivedFragment(), SetReceivedPacket(), and SetType().
uint64_t ns3::CtrlBAckResponseHeader::m_compressedBitmap |
the compressed block ack bitmap
Definition at line 403 of file ctrl-headers.h.
|
private |
multi TID
Definition at line 395 of file ctrl-headers.h.
Referenced by Deserialize(), DeserializeBitmap(), GetBaControl(), GetSerializedSize(), IsBasic(), IsCompressed(), IsFragmentReceived(), IsMultiTid(), IsPacketReceived(), Serialize(), SerializeBitmap(), SetBaControl(), SetReceivedFragment(), SetReceivedPacket(), and SetType().
|
private |
starting seq
Definition at line 398 of file ctrl-headers.h.
Referenced by GetStartingSequence(), GetStartingSequenceControl(), IndexInBitmap(), IsInBitmap(), Print(), SetStartingSequence(), and SetStartingSequenceControl().
|
private |
TID info.
Definition at line 397 of file ctrl-headers.h.
Referenced by GetBaControl(), GetSerializedSize(), GetTidInfo(), Print(), SetBaControl(), and SetTidInfo().