A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::zigbee::BroadcastTransactionTable Class Reference

The Broadcast Transaction Table (BTT) The BTT is used to keep track of data broadcast transactions. More...

#include "zigbee-nwk-tables.h"

+ Collaboration diagram for ns3::zigbee::BroadcastTransactionTable:

Public Member Functions

 BroadcastTransactionTable ()
 
bool AddEntry (Ptr< BroadcastTransactionRecord > entry)
 Add a broadcast transaction record (BTR) to the broadcast transaction table(BTT).
 
void Dispose ()
 Dispose of all broadcast transaction records (BTR) in the broadcast transaction table(BTT).
 
uint32_t GetMaxTableSize () const
 Get the maximum size of the broadcast transaction table (BTT)
 
uint32_t GetSize ()
 Get the current Size of the broadcast transaction table (BTT).
 
bool LookUpEntry (uint8_t seq, Ptr< BroadcastTransactionRecord > &entryFound)
 Look up for broadcast transaction record in the broadcast transaction table (BTT).
 
void Print (Ptr< OutputStreamWrapper > stream)
 Print the broadcast transaction table (BTT)
 
void Purge ()
 Purge expired entries from the broadcast transaction table (BTT).
 
void SetMaxTableSize (uint32_t size)
 Set the maximum size of the broadcast transaction table (BTT)
 

Private Attributes

std::deque< Ptr< BroadcastTransactionRecord > > m_broadcastTransactionTable
 The list object representing the broadcast transaction table (BTT)
 
uint32_t m_maxTableSize
 The maximum size of the Broadcast Transaction table.
 

Detailed Description

The Broadcast Transaction Table (BTT) The BTT is used to keep track of data broadcast transactions.

The broadcast of link status request and route requests (RREQ) commands are handled differently and not recorded by this table. See Zigbee specification r22.1.0, Section 3.6.5

Definition at line 1256 of file zigbee-nwk-tables.h.

Constructor & Destructor Documentation

◆ BroadcastTransactionTable()

ns3::zigbee::BroadcastTransactionTable::BroadcastTransactionTable ( )

Definition at line 1269 of file zigbee-nwk-tables.cc.

Member Function Documentation

◆ AddEntry()

bool ns3::zigbee::BroadcastTransactionTable::AddEntry ( Ptr< BroadcastTransactionRecord > entry)

Add a broadcast transaction record (BTR) to the broadcast transaction table(BTT).

Parameters
entryThe object representing the BTR
Returns
True if the object was added.

Definition at line 1274 of file zigbee-nwk-tables.cc.

References m_broadcastTransactionTable, and Purge().

Referenced by ns3::zigbee::ZigbeeNwk::McpsDataIndication().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Dispose()

void ns3::zigbee::BroadcastTransactionTable::Dispose ( )

Dispose of all broadcast transaction records (BTR) in the broadcast transaction table(BTT).

Definition at line 1325 of file zigbee-nwk-tables.cc.

References m_broadcastTransactionTable.

Referenced by ns3::zigbee::ZigbeeNwk::DoDispose().

+ Here is the caller graph for this function:

◆ GetMaxTableSize()

uint32_t ns3::zigbee::BroadcastTransactionTable::GetMaxTableSize ( ) const

Get the maximum size of the broadcast transaction table (BTT)

Returns
The maximum size of the broadcast transaction table (BTT).

Definition at line 1294 of file zigbee-nwk-tables.cc.

References m_maxTableSize.

◆ GetSize()

uint32_t ns3::zigbee::BroadcastTransactionTable::GetSize ( )

Get the current Size of the broadcast transaction table (BTT).

Returns
uint32_t

Definition at line 1282 of file zigbee-nwk-tables.cc.

References m_broadcastTransactionTable.

◆ LookUpEntry()

bool ns3::zigbee::BroadcastTransactionTable::LookUpEntry ( uint8_t seq,
Ptr< BroadcastTransactionRecord > & entryFound )

Look up for broadcast transaction record in the broadcast transaction table (BTT).

Parameters
seqThe sequence number of the broadcasted frame.
entryFoundThe returned entry if found in the table
Returns
True if a searched entry is found

Definition at line 1300 of file zigbee-nwk-tables.cc.

References m_broadcastTransactionTable, NS_LOG_FUNCTION, and Purge().

Referenced by ns3::zigbee::ZigbeeNwk::McpsDataIndication().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Print()

void ns3::zigbee::BroadcastTransactionTable::Print ( Ptr< OutputStreamWrapper > stream)

Print the broadcast transaction table (BTT)

Parameters
streamThe output stream where the table is printed

Definition at line 1335 of file zigbee-nwk-tables.cc.

References m_broadcastTransactionTable.

◆ Purge()

void ns3::zigbee::BroadcastTransactionTable::Purge ( )

Purge expired entries from the broadcast transaction table (BTT).

Definition at line 1317 of file zigbee-nwk-tables.cc.

References m_broadcastTransactionTable, and ns3::Simulator::Now().

Referenced by AddEntry(), and LookUpEntry().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetMaxTableSize()

void ns3::zigbee::BroadcastTransactionTable::SetMaxTableSize ( uint32_t size)

Set the maximum size of the broadcast transaction table (BTT)

Parameters
sizeThe size of the broadcast transaction table (BTT).

Definition at line 1288 of file zigbee-nwk-tables.cc.

References m_maxTableSize.

Member Data Documentation

◆ m_broadcastTransactionTable

std::deque<Ptr<BroadcastTransactionRecord> > ns3::zigbee::BroadcastTransactionTable::m_broadcastTransactionTable
private

The list object representing the broadcast transaction table (BTT)

Definition at line 1320 of file zigbee-nwk-tables.h.

Referenced by AddEntry(), Dispose(), GetSize(), LookUpEntry(), Print(), and Purge().

◆ m_maxTableSize

uint32_t ns3::zigbee::BroadcastTransactionTable::m_maxTableSize
private

The maximum size of the Broadcast Transaction table.

Definition at line 1318 of file zigbee-nwk-tables.h.

Referenced by GetMaxTableSize(), and SetMaxTableSize().


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