A Discrete-Event Network Simulator
API
Public Member Functions | Protected Attributes | Friends | List of all members
ns3::BlockAckAgreement Class Reference

Maintains information for a block ack agreement. More...

#include "block-ack-agreement.h"

+ Inheritance diagram for ns3::BlockAckAgreement:

Public Member Functions

 BlockAckAgreement (Mac48Address peer, uint8_t tid)
 Constructor for BlockAckAgreement with given peer and TID. More...
 
 ~BlockAckAgreement ()
 
uint16_t GetBufferSize (void) const
 Return the buffer size. More...
 
Mac48Address GetPeer (void) const
 Return the peer address. More...
 
uint16_t GetStartingSequence (void) const
 Return the starting squence number. More...
 
uint16_t GetStartingSequenceControl (void) const
 Return the starting sequence control. More...
 
uint8_t GetTid (void) const
 Return the Traffic ID (TID). More...
 
uint16_t GetTimeout (void) const
 Return the timeout. More...
 
uint16_t GetWinEnd (void) const
 Return the ending sequence number. More...
 
bool IsAmsduSupported (void) const
 Check whether A-MSDU is supported. More...
 
bool IsHtSupported (void) const
 Check whether HT is supported. More...
 
bool IsImmediateBlockAck (void) const
 Check whether the current ACK policy is immediate block ACK. More...
 
void SetAmsduSupport (bool supported)
 Enable or disable A-MSDU support. More...
 
void SetBufferSize (uint16_t bufferSize)
 Set buffer size. More...
 
void SetDelayedBlockAck (void)
 Set Block ACK policy to delayed ACK. More...
 
void SetHtSupported (bool htSupported)
 Enable or disable HT support. More...
 
void SetImmediateBlockAck (void)
 Set Block ACK policy to immediate ACK. More...
 
void SetStartingSequence (uint16_t seq)
 Set starting sequence number. More...
 
void SetStartingSequenceControl (uint16_t seq)
 Set starting sequence control. More...
 
void SetTimeout (uint16_t timeout)
 Set timeout. More...
 
void SetWinEnd (uint16_t seq)
 Set ending sequence number. More...
 

Protected Attributes

uint8_t m_amsduSupported
 Flag whether MSDU aggregation is supported. More...
 
uint8_t m_blockAckPolicy
 Type of block ack: immediate or delayed. More...
 
uint16_t m_bufferSize
 Buffer size. More...
 
uint8_t m_htSupported
 Flag whether HT is supported. More...
 
EventId m_inactivityEvent
 inactivity event More...
 
Mac48Address m_peer
 Peer address. More...
 
uint16_t m_startingSeq
 Starting squence control. More...
 
uint8_t m_tid
 Traffic ID. More...
 
uint16_t m_timeout
 Timeout. More...
 
uint16_t m_winEnd
 Ending sequence number. More...
 

Friends

class MacLow
 Provide access to MacLow class. More...
 

Detailed Description

Maintains information for a block ack agreement.

Definition at line 32 of file block-ack-agreement.h.

Constructor & Destructor Documentation

◆ BlockAckAgreement()

ns3::BlockAckAgreement::BlockAckAgreement ( Mac48Address  peer,
uint8_t  tid 
)

Constructor for BlockAckAgreement with given peer and TID.

Parameters
peer
tid

Definition at line 28 of file block-ack-agreement.cc.

References m_peer, m_tid, and NS_LOG_FUNCTION.

◆ ~BlockAckAgreement()

ns3::BlockAckAgreement::~BlockAckAgreement ( )

Definition at line 39 of file block-ack-agreement.cc.

References ns3::EventId::Cancel(), m_inactivityEvent, and NS_LOG_FUNCTION.

Member Function Documentation

◆ GetBufferSize()

uint16_t ns3::BlockAckAgreement::GetBufferSize ( void  ) const

Return the buffer size.

Returns
buffer size

Definition at line 113 of file block-ack-agreement.cc.

References m_bufferSize, and NS_LOG_FUNCTION.

◆ GetPeer()

Mac48Address ns3::BlockAckAgreement::GetPeer ( void  ) const

Return the peer address.

Returns
Mac48Address

Definition at line 106 of file block-ack-agreement.cc.

References m_peer, and NS_LOG_FUNCTION.

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

◆ GetStartingSequence()

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

Return the starting squence number.

Returns
starting sequence number

Definition at line 127 of file block-ack-agreement.cc.

References m_startingSeq, and NS_LOG_FUNCTION.

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

◆ GetStartingSequenceControl()

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

Return the starting sequence control.

Returns
starting sequence control

Definition at line 134 of file block-ack-agreement.cc.

References m_startingSeq, and NS_LOG_FUNCTION.

◆ GetTid()

uint8_t ns3::BlockAckAgreement::GetTid ( void  ) const

◆ GetTimeout()

uint16_t ns3::BlockAckAgreement::GetTimeout ( void  ) const

◆ GetWinEnd()

uint16_t ns3::BlockAckAgreement::GetWinEnd ( void  ) const

Return the ending sequence number.

Returns
ending sequence number

Definition at line 156 of file block-ack-agreement.cc.

References m_winEnd.

◆ IsAmsduSupported()

bool ns3::BlockAckAgreement::IsAmsduSupported ( void  ) const

Check whether A-MSDU is supported.

Returns
true if A-MSDU is supported, false otherwise

Definition at line 149 of file block-ack-agreement.cc.

References m_amsduSupported, and NS_LOG_FUNCTION.

◆ IsHtSupported()

bool ns3::BlockAckAgreement::IsHtSupported ( void  ) const

Check whether HT is supported.

Returns
true if HT is supported, false otherwise

Definition at line 175 of file block-ack-agreement.cc.

References m_htSupported, and NS_LOG_FUNCTION.

◆ IsImmediateBlockAck()

bool ns3::BlockAckAgreement::IsImmediateBlockAck ( void  ) const

Check whether the current ACK policy is immediate block ACK.

Returns
true if the current ACK policy is immediate block ACK, false otherwise

Definition at line 142 of file block-ack-agreement.cc.

References m_blockAckPolicy, and NS_LOG_FUNCTION.

◆ SetAmsduSupport()

void ns3::BlockAckAgreement::SetAmsduSupport ( bool  supported)

Enable or disable A-MSDU support.

Parameters
supportedenable or disable A-MSDU support

Definition at line 92 of file block-ack-agreement.cc.

References m_amsduSupported, and NS_LOG_FUNCTION.

Referenced by ns3::MacLow::CreateBlockAckAgreement(), and ns3::BlockAckManager::UpdateAgreement().

◆ SetBufferSize()

void ns3::BlockAckAgreement::SetBufferSize ( uint16_t  bufferSize)

Set buffer size.

Parameters
bufferSize

Definition at line 46 of file block-ack-agreement.cc.

References m_bufferSize, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by ns3::MacLow::CreateBlockAckAgreement(), and ns3::BlockAckManager::UpdateAgreement().

◆ SetDelayedBlockAck()

void ns3::BlockAckAgreement::SetDelayedBlockAck ( void  )

Set Block ACK policy to delayed ACK.

Definition at line 85 of file block-ack-agreement.cc.

References m_blockAckPolicy, and NS_LOG_FUNCTION.

Referenced by ns3::MacLow::CreateBlockAckAgreement(), and ns3::BlockAckManager::UpdateAgreement().

◆ SetHtSupported()

void ns3::BlockAckAgreement::SetHtSupported ( bool  htSupported)

Enable or disable HT support.

Parameters
htSupportedenable or disable HT support

Definition at line 168 of file block-ack-agreement.cc.

References m_htSupported, and NS_LOG_FUNCTION.

◆ SetImmediateBlockAck()

void ns3::BlockAckAgreement::SetImmediateBlockAck ( void  )

Set Block ACK policy to immediate ACK.

Definition at line 78 of file block-ack-agreement.cc.

References m_blockAckPolicy, and NS_LOG_FUNCTION.

Referenced by ns3::MacLow::CreateBlockAckAgreement(), and ns3::BlockAckManager::UpdateAgreement().

◆ SetStartingSequence()

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

Set starting sequence number.

Parameters
seqthe starting sequence number

Definition at line 62 of file block-ack-agreement.cc.

References m_startingSeq, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by ns3::BlockAckManager::CreateAgreement(), and ns3::MacLow::CreateBlockAckAgreement().

◆ SetStartingSequenceControl()

void ns3::BlockAckAgreement::SetStartingSequenceControl ( uint16_t  seq)

Set starting sequence control.

Parameters
seqthe starting sequence control

Definition at line 70 of file block-ack-agreement.cc.

References m_startingSeq, NS_ASSERT, and NS_LOG_FUNCTION.

◆ SetTimeout()

void ns3::BlockAckAgreement::SetTimeout ( uint16_t  timeout)

Set timeout.

Parameters
timeout

Definition at line 55 of file block-ack-agreement.cc.

References m_timeout, NS_LOG_FUNCTION, and timeout.

Referenced by ns3::MacLow::CreateBlockAckAgreement(), and ns3::BlockAckManager::UpdateAgreement().

◆ SetWinEnd()

void ns3::BlockAckAgreement::SetWinEnd ( uint16_t  seq)

Set ending sequence number.

Parameters
seqthe ending sequence number

Definition at line 162 of file block-ack-agreement.cc.

References m_winEnd.

Friends And Related Function Documentation

◆ MacLow

friend class MacLow
friend

Provide access to MacLow class.

Definition at line 35 of file block-ack-agreement.h.

Member Data Documentation

◆ m_amsduSupported

uint8_t ns3::BlockAckAgreement::m_amsduSupported
protected

Flag whether MSDU aggregation is supported.

Definition at line 164 of file block-ack-agreement.h.

Referenced by IsAmsduSupported(), and SetAmsduSupport().

◆ m_blockAckPolicy

uint8_t ns3::BlockAckAgreement::m_blockAckPolicy
protected

Type of block ack: immediate or delayed.

Definition at line 165 of file block-ack-agreement.h.

Referenced by IsImmediateBlockAck(), SetDelayedBlockAck(), and SetImmediateBlockAck().

◆ m_bufferSize

uint16_t ns3::BlockAckAgreement::m_bufferSize
protected

◆ m_htSupported

uint8_t ns3::BlockAckAgreement::m_htSupported
protected

Flag whether HT is supported.

Definition at line 171 of file block-ack-agreement.h.

Referenced by IsHtSupported(), and SetHtSupported().

◆ m_inactivityEvent

EventId ns3::BlockAckAgreement::m_inactivityEvent
protected

◆ m_peer

Mac48Address ns3::BlockAckAgreement::m_peer
protected

Peer address.

Definition at line 163 of file block-ack-agreement.h.

Referenced by BlockAckAgreement(), and GetPeer().

◆ m_startingSeq

uint16_t ns3::BlockAckAgreement::m_startingSeq
protected

◆ m_tid

uint8_t ns3::BlockAckAgreement::m_tid
protected

Traffic ID.

Definition at line 166 of file block-ack-agreement.h.

Referenced by BlockAckAgreement(), and GetTid().

◆ m_timeout

uint16_t ns3::BlockAckAgreement::m_timeout
protected

Timeout.

Definition at line 168 of file block-ack-agreement.h.

Referenced by GetTimeout(), and SetTimeout().

◆ m_winEnd

uint16_t ns3::BlockAckAgreement::m_winEnd
protected

Ending sequence number.

Definition at line 170 of file block-ack-agreement.h.

Referenced by GetWinEnd(), and SetWinEnd().


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