A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
ns3::ServiceFlowRecord Class Reference
WiMAX Models

this class implements a structure to manage some parameters and statistics related to a service flow More...

#include "service-flow-record.h"

+ Collaboration diagram for ns3::ServiceFlowRecord:

Public Member Functions

 ServiceFlowRecord ()
 
 ~ServiceFlowRecord ()
 
uint32_t GetBacklogged () const
 
uint32_t GetBackloggedTemp () const
 
uint32_t GetBwSinceLastExpiry () const
 
uint32_t GetBytesRcvd () const
 
uint32_t GetBytesSent () const
 
Time GetDlTimeStamp () const
 
uint32_t GetGrantedBandwidth () const
 
uint32_t GetGrantedBandwidthTemp () const
 
uint32_t GetGrantSize () const
 
Time GetGrantTimeStamp () const
 
Time GetLastGrantTime () const
 
uint32_t GetPktsRcvd () const
 
uint32_t GetPktsSent () const
 
uint32_t GetRequestedBandwidth () const
 
void IncreaseBacklogged (uint32_t backlogged)
 increase backlogged
 
void IncreaseBackloggedTemp (uint32_t backloggedTemp)
 increase temporary back logged
 
void SetBacklogged (uint32_t backlogged)
 set backlogged
 
void SetBackloggedTemp (uint32_t backloggedTemp)
 set temporary back logged
 
void SetBwSinceLastExpiry (uint32_t bwSinceLastExpiry)
 set BW since last expiry
 
void SetBytesRcvd (uint32_t bytesRcvd)
 Set the number of received bytes.
 
void SetBytesSent (uint32_t bytesSent)
 Set the number of sent bytes.
 
void SetDlTimeStamp (Time dlTimeStamp)
 Set the DlTimeStamp.
 
void SetGrantedBandwidth (uint32_t grantedBandwidth)
 set the granted bandwidth
 
void SetGrantedBandwidthTemp (uint32_t grantedBandwidthTemp)
 set the temporary granted bandwidth
 
void SetGrantSize (uint32_t grantSize)
 Set the grant size (only for UGS service flows)
 
void SetGrantTimeStamp (Time grantTimeStamp)
 Set the grant time stamp.
 
void SetLastGrantTime (Time grantTime)
 set last grant time
 
void SetPktsRcvd (uint32_t pktsRcvd)
 Set the number of received packets.
 
void SetPktsSent (uint32_t pktsSent)
 set the number of sent packets in this service flow
 
void SetRequestedBandwidth (uint32_t requestedBandwidth)
 set the requested bandwidth
 
void UpdateBwSinceLastExpiry (uint32_t bwSinceLastExpiry)
 update BW since last expiry
 
void UpdateBytesRcvd (uint32_t bytesRcvd)
 update the number of received bytes by adding bytesRcvd
 
void UpdateBytesSent (uint32_t bytesSent)
 update the number of sent bytes by adding bytesSent
 
void UpdateGrantedBandwidth (uint32_t grantedBandwidth)
 update the granted bandwidth
 
void UpdateGrantedBandwidthTemp (uint32_t grantedBandwidthTemp)
 update the temporary granted bandwidth
 
void UpdatePktsRcvd (uint32_t pktsRcvd)
 update the number of received packets by adding pktsRcvd
 
void UpdatePktsSent (uint32_t pktsSent)
 update the number of sent packets by adding pktsSent
 
void UpdateRequestedBandwidth (uint32_t requestedBandwidth)
 update the requested bandwidth
 

Private Attributes

int32_t m_backlogged
 back logged
 
int32_t m_backloggedTemp
 back logged temp
 
uint32_t m_bwSinceLastExpiry
 bandwidth granted since last expiry of minimum reserved traffic rate interval, only for nrtPS, to make sure minimum reserved traffic rate is maintained
 
uint32_t m_bytesRcvd
 bytes received
 
uint32_t m_bytesSent
 bytes sent
 
Time m_dlTimeStamp
 time when this service flow's traffic was last sent
 
uint32_t m_grantedBandwidth
 granted badnwidth
 
uint32_t m_grantedBandwidthTemp
 Temporary variable used to sort list.
 
uint32_t m_grantSize
 only used for UGS flow
 
Time m_grantTimeStamp
 allocation (for data) for UGS flows and unicast poll (for bandwidth requests) for non-UGS flows
 
Time m_lastGrantTime
 last grant time
 
uint32_t m_pktsRcvd
 packets received
 
uint32_t m_pktsSent
 packets sent
 
uint32_t m_requestedBandwidth
 requested bandwidth
 

Detailed Description

this class implements a structure to manage some parameters and statistics related to a service flow

Definition at line 28 of file service-flow-record.h.

Constructor & Destructor Documentation

◆ ServiceFlowRecord()

ns3::ServiceFlowRecord::ServiceFlowRecord ( )

Definition at line 14 of file service-flow-record.cc.

References m_backlogged, m_backloggedTemp, m_grantedBandwidthTemp, m_lastGrantTime, and ns3::Seconds().

+ Here is the call graph for this function:

◆ ~ServiceFlowRecord()

ns3::ServiceFlowRecord::~ServiceFlowRecord ( )

Definition at line 32 of file service-flow-record.cc.

Member Function Documentation

◆ GetBacklogged()

uint32_t ns3::ServiceFlowRecord::GetBacklogged ( ) const
Returns
The number of backlogged

Definition at line 223 of file service-flow-record.cc.

References m_backlogged.

◆ GetBackloggedTemp()

uint32_t ns3::ServiceFlowRecord::GetBackloggedTemp ( ) const
Returns
The value of temporary backlogged

Definition at line 241 of file service-flow-record.cc.

References m_backloggedTemp.

◆ GetBwSinceLastExpiry()

uint32_t ns3::ServiceFlowRecord::GetBwSinceLastExpiry ( ) const
Returns
The bandwidth since last expiry

Definition at line 259 of file service-flow-record.cc.

References m_bwSinceLastExpiry.

◆ GetBytesRcvd()

uint32_t ns3::ServiceFlowRecord::GetBytesRcvd ( ) const
Returns
The number of received bytes

Definition at line 139 of file service-flow-record.cc.

References m_bytesRcvd.

◆ GetBytesSent()

uint32_t ns3::ServiceFlowRecord::GetBytesSent ( ) const
Returns
The number of sent bytes

Definition at line 121 of file service-flow-record.cc.

References m_bytesSent.

◆ GetDlTimeStamp()

Time ns3::ServiceFlowRecord::GetDlTimeStamp ( ) const
Returns
the DlTimeStamp: time when this service flow's traffic was last sent

Definition at line 67 of file service-flow-record.cc.

References m_dlTimeStamp.

◆ GetGrantedBandwidth()

uint32_t ns3::ServiceFlowRecord::GetGrantedBandwidth ( ) const
Returns
The granted bandwidth

Definition at line 175 of file service-flow-record.cc.

References m_grantedBandwidth.

◆ GetGrantedBandwidthTemp()

uint32_t ns3::ServiceFlowRecord::GetGrantedBandwidthTemp ( ) const
Returns
The temporary granted bandwidth

Definition at line 193 of file service-flow-record.cc.

References m_grantedBandwidthTemp.

◆ GetGrantSize()

uint32_t ns3::ServiceFlowRecord::GetGrantSize ( ) const
Returns
the grant size (only for ugs service flows)

Definition at line 43 of file service-flow-record.cc.

References m_grantSize.

Referenced by ns3::BSSchedulerRtps::BSSchedulerUGSConnection().

+ Here is the caller graph for this function:

◆ GetGrantTimeStamp()

Time ns3::ServiceFlowRecord::GetGrantTimeStamp ( ) const
Returns
the grant time stamp. Used for data allocation for ugs flows, and unicast poll (bw request) for non-UGS flows

Definition at line 55 of file service-flow-record.cc.

References m_grantTimeStamp.

◆ GetLastGrantTime()

Time ns3::ServiceFlowRecord::GetLastGrantTime ( ) const
Returns
The last grant time

Definition at line 205 of file service-flow-record.cc.

References m_lastGrantTime.

◆ GetPktsRcvd()

uint32_t ns3::ServiceFlowRecord::GetPktsRcvd ( ) const
Returns
the number of received packet

Definition at line 103 of file service-flow-record.cc.

References m_pktsRcvd.

◆ GetPktsSent()

uint32_t ns3::ServiceFlowRecord::GetPktsSent ( ) const
Returns
the number of sent packet in this service flow

Definition at line 85 of file service-flow-record.cc.

References m_pktsSent.

◆ GetRequestedBandwidth()

uint32_t ns3::ServiceFlowRecord::GetRequestedBandwidth ( ) const
Returns
The requested bandwidth

Definition at line 157 of file service-flow-record.cc.

References m_requestedBandwidth.

◆ IncreaseBacklogged()

void ns3::ServiceFlowRecord::IncreaseBacklogged ( uint32_t  backlogged)

increase backlogged

Parameters
backloggedthe number of backlogged to update

Definition at line 217 of file service-flow-record.cc.

References ns3::Create(), and m_backlogged.

+ Here is the call graph for this function:

◆ IncreaseBackloggedTemp()

void ns3::ServiceFlowRecord::IncreaseBackloggedTemp ( uint32_t  backloggedTemp)

increase temporary back logged

Parameters
backloggedTempthe temporary backlogged value

Definition at line 235 of file service-flow-record.cc.

References ns3::Create(), and m_backloggedTemp.

+ Here is the call graph for this function:

◆ SetBacklogged()

void ns3::ServiceFlowRecord::SetBacklogged ( uint32_t  backlogged)

set backlogged

Parameters
backloggednumber of backlogged

Definition at line 211 of file service-flow-record.cc.

References ns3::Create(), and m_backlogged.

+ Here is the call graph for this function:

◆ SetBackloggedTemp()

void ns3::ServiceFlowRecord::SetBackloggedTemp ( uint32_t  backloggedTemp)

set temporary back logged

Parameters
backloggedTempthe temporary backlogged value

Definition at line 229 of file service-flow-record.cc.

References ns3::Create(), and m_backloggedTemp.

Referenced by ns3::UplinkSchedulerMBQoS::CheckMinimumBandwidth().

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

◆ SetBwSinceLastExpiry()

void ns3::ServiceFlowRecord::SetBwSinceLastExpiry ( uint32_t  bwSinceLastExpiry)

set BW since last expiry

Parameters
bwSinceLastExpirybandwidth since last expiry

Definition at line 247 of file service-flow-record.cc.

References ns3::Create(), and m_bwSinceLastExpiry.

+ Here is the call graph for this function:

◆ SetBytesRcvd()

void ns3::ServiceFlowRecord::SetBytesRcvd ( uint32_t  bytesRcvd)

Set the number of received bytes.

Parameters
bytesRcvdthe number of received bytes

Definition at line 127 of file service-flow-record.cc.

References ns3::Create(), and m_bytesRcvd.

+ Here is the call graph for this function:

◆ SetBytesSent()

void ns3::ServiceFlowRecord::SetBytesSent ( uint32_t  bytesSent)

Set the number of sent bytes.

Parameters
bytesSentthe number of sent bytes

Definition at line 109 of file service-flow-record.cc.

References ns3::Create(), and m_bytesSent.

+ Here is the call graph for this function:

◆ SetDlTimeStamp()

void ns3::ServiceFlowRecord::SetDlTimeStamp ( Time  dlTimeStamp)

Set the DlTimeStamp.

Parameters
dlTimeStamptime when this service flow's traffic was last sent.

Definition at line 61 of file service-flow-record.cc.

References ns3::Create(), and m_dlTimeStamp.

+ Here is the call graph for this function:

◆ SetGrantedBandwidth()

void ns3::ServiceFlowRecord::SetGrantedBandwidth ( uint32_t  grantedBandwidth)

set the granted bandwidth

Parameters
grantedBandwidththe granted bandwidth

Definition at line 163 of file service-flow-record.cc.

References ns3::Create(), and m_grantedBandwidth.

+ Here is the call graph for this function:

◆ SetGrantedBandwidthTemp()

void ns3::ServiceFlowRecord::SetGrantedBandwidthTemp ( uint32_t  grantedBandwidthTemp)

set the temporary granted bandwidth

Parameters
grantedBandwidthTempthe temporary granted bandwidth

Definition at line 181 of file service-flow-record.cc.

References ns3::Create(), and m_grantedBandwidthTemp.

+ Here is the call graph for this function:

◆ SetGrantSize()

void ns3::ServiceFlowRecord::SetGrantSize ( uint32_t  grantSize)

Set the grant size (only for UGS service flows)

Parameters
grantSizethe grant size to set

Definition at line 37 of file service-flow-record.cc.

References ns3::Create(), and m_grantSize.

+ Here is the call graph for this function:

◆ SetGrantTimeStamp()

void ns3::ServiceFlowRecord::SetGrantTimeStamp ( Time  grantTimeStamp)

Set the grant time stamp.

Used for data allocation for ugs flows, and unicast poll (bw request) for non-UGS flows

Parameters
grantTimeStampthe grant time stamp to set

Definition at line 49 of file service-flow-record.cc.

References ns3::Create(), and m_grantTimeStamp.

+ Here is the call graph for this function:

◆ SetLastGrantTime()

void ns3::ServiceFlowRecord::SetLastGrantTime ( Time  grantTime)

set last grant time

Parameters
grantTimegrant time to set

Definition at line 199 of file service-flow-record.cc.

References ns3::Create(), and m_lastGrantTime.

+ Here is the call graph for this function:

◆ SetPktsRcvd()

void ns3::ServiceFlowRecord::SetPktsRcvd ( uint32_t  pktsRcvd)

Set the number of received packets.

Parameters
pktsRcvdThe number of received packets

Definition at line 91 of file service-flow-record.cc.

References ns3::Create(), and m_pktsRcvd.

+ Here is the call graph for this function:

◆ SetPktsSent()

void ns3::ServiceFlowRecord::SetPktsSent ( uint32_t  pktsSent)

set the number of sent packets in this service flow

Parameters
pktsSentthe number of sent packets

Definition at line 73 of file service-flow-record.cc.

References ns3::Create(), and m_pktsSent.

+ Here is the call graph for this function:

◆ SetRequestedBandwidth()

void ns3::ServiceFlowRecord::SetRequestedBandwidth ( uint32_t  requestedBandwidth)

set the requested bandwidth

Parameters
requestedBandwidththe requested bandwidth

Definition at line 145 of file service-flow-record.cc.

References ns3::Create(), and m_requestedBandwidth.

+ Here is the call graph for this function:

◆ UpdateBwSinceLastExpiry()

void ns3::ServiceFlowRecord::UpdateBwSinceLastExpiry ( uint32_t  bwSinceLastExpiry)

update BW since last expiry

Parameters
bwSinceLastExpirybandwidth since last expiry

Definition at line 253 of file service-flow-record.cc.

References ns3::Create(), and m_bwSinceLastExpiry.

Referenced by ns3::UplinkSchedulerMBQoS::UplinkSchedWindowTimer().

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

◆ UpdateBytesRcvd()

void ns3::ServiceFlowRecord::UpdateBytesRcvd ( uint32_t  bytesRcvd)

update the number of received bytes by adding bytesRcvd

Parameters
bytesRcvdthe number of bytes to add

Definition at line 133 of file service-flow-record.cc.

References ns3::Create(), and m_bytesRcvd.

+ Here is the call graph for this function:

◆ UpdateBytesSent()

void ns3::ServiceFlowRecord::UpdateBytesSent ( uint32_t  bytesSent)

update the number of sent bytes by adding bytesSent

Parameters
bytesSentthe number of bytes to add

Definition at line 115 of file service-flow-record.cc.

References ns3::Create(), and m_bytesSent.

+ Here is the call graph for this function:

◆ UpdateGrantedBandwidth()

void ns3::ServiceFlowRecord::UpdateGrantedBandwidth ( uint32_t  grantedBandwidth)

update the granted bandwidth

Parameters
grantedBandwidththe granted bandwidth update

Definition at line 169 of file service-flow-record.cc.

References ns3::Create(), and m_grantedBandwidth.

+ Here is the call graph for this function:

◆ UpdateGrantedBandwidthTemp()

void ns3::ServiceFlowRecord::UpdateGrantedBandwidthTemp ( uint32_t  grantedBandwidthTemp)

update the temporary granted bandwidth

Parameters
grantedBandwidthTempthe temporary granted bandwidth

Definition at line 187 of file service-flow-record.cc.

References ns3::Create(), and m_grantedBandwidthTemp.

+ Here is the call graph for this function:

◆ UpdatePktsRcvd()

void ns3::ServiceFlowRecord::UpdatePktsRcvd ( uint32_t  pktsRcvd)

update the number of received packets by adding pktsRcvd

Parameters
pktsRcvdthe number of received packets to add

Definition at line 97 of file service-flow-record.cc.

References ns3::Create(), and m_pktsRcvd.

Referenced by ns3::SubscriberStationNetDevice::DoReceive().

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

◆ UpdatePktsSent()

void ns3::ServiceFlowRecord::UpdatePktsSent ( uint32_t  pktsSent)

update the number of sent packets by adding pktsSent

Parameters
pktsSentthe number of sent packets to add

Definition at line 79 of file service-flow-record.cc.

References ns3::Create(), and m_pktsSent.

Referenced by ns3::SubscriberStationNetDevice::SendBurst().

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

◆ UpdateRequestedBandwidth()

void ns3::ServiceFlowRecord::UpdateRequestedBandwidth ( uint32_t  requestedBandwidth)

update the requested bandwidth

Parameters
requestedBandwidththe requested bandwidth update

Definition at line 151 of file service-flow-record.cc.

References ns3::Create(), and m_requestedBandwidth.

+ Here is the call graph for this function:

Member Data Documentation

◆ m_backlogged

int32_t ns3::ServiceFlowRecord::m_backlogged
private

back logged

Definition at line 242 of file service-flow-record.h.

Referenced by ServiceFlowRecord(), GetBacklogged(), IncreaseBacklogged(), and SetBacklogged().

◆ m_backloggedTemp

int32_t ns3::ServiceFlowRecord::m_backloggedTemp
private

back logged temp

Definition at line 243 of file service-flow-record.h.

Referenced by ServiceFlowRecord(), GetBackloggedTemp(), IncreaseBackloggedTemp(), and SetBackloggedTemp().

◆ m_bwSinceLastExpiry

uint32_t ns3::ServiceFlowRecord::m_bwSinceLastExpiry
private

bandwidth granted since last expiry of minimum reserved traffic rate interval, only for nrtPS, to make sure minimum reserved traffic rate is maintained

Definition at line 240 of file service-flow-record.h.

Referenced by GetBwSinceLastExpiry(), SetBwSinceLastExpiry(), and UpdateBwSinceLastExpiry().

◆ m_bytesRcvd

uint32_t ns3::ServiceFlowRecord::m_bytesRcvd
private

bytes received

Definition at line 231 of file service-flow-record.h.

Referenced by GetBytesRcvd(), SetBytesRcvd(), and UpdateBytesRcvd().

◆ m_bytesSent

uint32_t ns3::ServiceFlowRecord::m_bytesSent
private

bytes sent

Definition at line 230 of file service-flow-record.h.

Referenced by GetBytesSent(), SetBytesSent(), and UpdateBytesSent().

◆ m_dlTimeStamp

Time ns3::ServiceFlowRecord::m_dlTimeStamp
private

time when this service flow's traffic was last sent

Definition at line 224 of file service-flow-record.h.

Referenced by GetDlTimeStamp(), and SetDlTimeStamp().

◆ m_grantedBandwidth

uint32_t ns3::ServiceFlowRecord::m_grantedBandwidth
private

granted badnwidth

Definition at line 234 of file service-flow-record.h.

Referenced by GetGrantedBandwidth(), SetGrantedBandwidth(), and UpdateGrantedBandwidth().

◆ m_grantedBandwidthTemp

uint32_t ns3::ServiceFlowRecord::m_grantedBandwidthTemp
private

Temporary variable used to sort list.

Necessary to keep original order

Definition at line 235 of file service-flow-record.h.

Referenced by ServiceFlowRecord(), GetGrantedBandwidthTemp(), SetGrantedBandwidthTemp(), and UpdateGrantedBandwidthTemp().

◆ m_grantSize

uint32_t ns3::ServiceFlowRecord::m_grantSize
private

only used for UGS flow

Definition at line 221 of file service-flow-record.h.

Referenced by GetGrantSize(), and SetGrantSize().

◆ m_grantTimeStamp

Time ns3::ServiceFlowRecord::m_grantTimeStamp
private

allocation (for data) for UGS flows and unicast poll (for bandwidth requests) for non-UGS flows

Definition at line 222 of file service-flow-record.h.

Referenced by GetGrantTimeStamp(), and SetGrantTimeStamp().

◆ m_lastGrantTime

Time ns3::ServiceFlowRecord::m_lastGrantTime
private

last grant time

Definition at line 241 of file service-flow-record.h.

Referenced by ServiceFlowRecord(), GetLastGrantTime(), and SetLastGrantTime().

◆ m_pktsRcvd

uint32_t ns3::ServiceFlowRecord::m_pktsRcvd
private

packets received

Definition at line 228 of file service-flow-record.h.

Referenced by GetPktsRcvd(), SetPktsRcvd(), and UpdatePktsRcvd().

◆ m_pktsSent

uint32_t ns3::ServiceFlowRecord::m_pktsSent
private

packets sent

Definition at line 227 of file service-flow-record.h.

Referenced by GetPktsSent(), SetPktsSent(), and UpdatePktsSent().

◆ m_requestedBandwidth

uint32_t ns3::ServiceFlowRecord::m_requestedBandwidth
private

requested bandwidth

Definition at line 233 of file service-flow-record.h.

Referenced by GetRequestedBandwidth(), SetRequestedBandwidth(), and UpdateRequestedBandwidth().

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