A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 (void)
 ~ServiceFlowRecord (void)
uint32_t GetBacklogged (void) const
uint32_t GetBackloggedTemp (void) const
uint32_t GetBwSinceLastExpiry (void)
uint32_t GetBytesRcvd (void) const
uint32_t GetBytesSent (void) const
Time GetDlTimeStamp (void) const
uint32_t GetGrantedBandwidth (void)
uint32_t GetGrantedBandwidthTemp (void)
uint32_t GetGrantSize (void) const
Time GetGrantTimeStamp (void) const
Time GetLastGrantTime (void) const
uint32_t GetPktsRcvd (void) const
uint32_t GetPktsSent (void) const
uint32_t GetRequestedBandwidth (void)
void IncreaseBacklogged (uint32_t backlogged)
void IncreaseBackloggedTemp (uint32_t backloggedTemp)
void SetBacklogged (uint32_t backlogged)
void SetBackloggedTemp (uint32_t backloggedTemp)
void SetBwSinceLastExpiry (uint32_t bwSinceLastExpiry)
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)
void SetGrantedBandwidthTemp (uint32_t grantedBandwidthTemp)
void SetGrantSize (uint32_t grantSize)
 Set the grant size (only for UGS service flows)
void SetGrantTimeStamp (Time grantTimeStamp)
 Set the grant time stamp. Used for data alocation for ugs flows, and unicast poll (bw request) for non-UGS flows.
void SetLastGrantTime (Time grantTime)
void SetPktsRcvd (uint32_t pktsRcvd)
 Set the number of received packet.
void SetPktsSent (uint32_t pktsSent)
 set the number of sent packets in this service flow
void SetRequestedBandwidth (uint32_t requestedBandwidth)
void UpdateBwSinceLastExpiry (uint32_t bwSinceLastExpiry)
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)
void UpdateGrantedBandwidthTemp (uint32_t grantedBandwidthTemp)
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)

Private Attributes

int32_t m_backlogged
int32_t m_backloggedTemp
uint32_t m_bwSinceLastExpiry
uint32_t m_bytesRcvd
uint32_t m_bytesSent
Time m_dlTimeStamp
uint32_t m_grantedBandwidth
uint32_t m_grantedBandwidthTemp
uint32_t m_grantSize
Time m_grantTimeStamp
Time m_lastGrantTime
uint32_t m_pktsRcvd
uint32_t m_pktsSent
uint32_t m_requestedBandwidth

Detailed Description

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

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

Constructor & Destructor Documentation

ns3::ServiceFlowRecord::ServiceFlowRecord ( void  )

Definition at line 25 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:

ns3::ServiceFlowRecord::~ServiceFlowRecord ( void  )

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

Member Function Documentation

uint32_t ns3::ServiceFlowRecord::GetBacklogged ( void  ) const

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

References m_backlogged.

Referenced by ns3::UplinkSchedulerMBQoS::CheckMinimumBandwidth(), ns3::SortProcess::operator()(), ns3::UplinkSchedulerMBQoS::ServiceBandwidthRequests(), and ns3::UplinkSchedulerMBQoS::UplinkSchedWindowTimer().

+ Here is the caller graph for this function:

uint32_t ns3::ServiceFlowRecord::GetBackloggedTemp ( void  ) const

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

References m_backloggedTemp.

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

+ Here is the caller graph for this function:

uint32_t ns3::ServiceFlowRecord::GetBwSinceLastExpiry ( void  )

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

References m_bwSinceLastExpiry.

Referenced by ns3::UplinkSchedulerMBQoS::CheckMinimumBandwidth(), ns3::UplinkSchedulerSimple::ServiceUnsolicitedGrants(), ns3::UplinkSchedulerRtps::ServiceUnsolicitedGrants(), and ns3::UplinkSchedulerMBQoS::UplinkSchedWindowTimer().

+ Here is the caller graph for this function:

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

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

References m_bytesRcvd.

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

+ Here is the caller graph for this function:

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

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

References m_bytesSent.

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

+ Here is the caller graph for this function:

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

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

References m_dlTimeStamp.

Referenced by ns3::BSSchedulerRtps::BSSchedulerUGSConnection(), and ns3::BSSchedulerSimple::SelectConnection().

+ Here is the caller graph for this function:

uint32_t ns3::ServiceFlowRecord::GetGrantedBandwidth ( void  )

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

References m_grantedBandwidth.

Referenced by ns3::UplinkSchedulerMBQoS::CheckMinimumBandwidth(), ns3::UplinkSchedulerMBQoS::CountSymbolsJobs(), ns3::UplinkSchedulerSimple::ServiceBandwidthRequests(), ns3::UplinkSchedulerRtps::ServiceBandwidthRequests(), ns3::UplinkSchedulerMBQoS::ServiceBandwidthRequests(), and ns3::UplinkSchedulerRtps::ULSchedulerRTPSConnection().

+ Here is the caller graph for this function:

uint32_t ns3::ServiceFlowRecord::GetGrantedBandwidthTemp ( void  )

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

References m_grantedBandwidthTemp.

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

+ Here is the caller graph for this function:

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

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

References m_grantSize.

Referenced by ns3::BSSchedulerRtps::BSSchedulerUGSConnection(), ns3::BandwidthManager::CalculateAllocationSize(), and ns3::BSSchedulerSimple::Schedule().

+ Here is the caller graph for this function:

Time ns3::ServiceFlowRecord::GetGrantTimeStamp ( void  ) 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 67 of file service-flow-record.cc.

References m_grantTimeStamp.

Referenced by ns3::BandwidthManager::CalculateAllocationSize(), ns3::UplinkSchedulerMBQoS::CountSymbolsJobs(), ns3::UplinkSchedulerSimple::ServiceUnsolicitedGrants(), and ns3::UplinkSchedulerRtps::ServiceUnsolicitedGrants().

+ Here is the caller graph for this function:

Time ns3::ServiceFlowRecord::GetLastGrantTime ( void  ) const

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

References m_lastGrantTime.

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

+ Here is the caller graph for this function:

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

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

References m_pktsRcvd.

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

+ Here is the caller graph for this function:

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

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

References m_pktsSent.

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

+ Here is the caller graph for this function:

uint32_t ns3::ServiceFlowRecord::GetRequestedBandwidth ( void  )

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

References m_requestedBandwidth.

Referenced by ns3::UplinkSchedulerMBQoS::CheckMinimumBandwidth(), ns3::UplinkSchedulerMBQoS::CountSymbolsJobs(), ns3::UplinkSchedulerSimple::ServiceBandwidthRequests(), ns3::UplinkSchedulerRtps::ServiceBandwidthRequests(), ns3::UplinkSchedulerMBQoS::ServiceBandwidthRequests(), ns3::UplinkSchedulerMBQoS::ServiceBandwidthRequestsBytes(), and ns3::UplinkSchedulerRtps::ULSchedulerRTPSConnection().

+ Here is the caller graph for this function:

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

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

References m_backlogged.

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

+ Here is the caller graph for this function:

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

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

References m_backloggedTemp.

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

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

References m_backlogged.

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

+ Here is the caller graph for this function:

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

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

References m_backloggedTemp.

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

+ Here is the caller graph for this function:

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

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

References m_bwSinceLastExpiry.

Referenced by ns3::UplinkSchedulerSimple::ServiceBandwidthRequests(), ns3::UplinkSchedulerRtps::ServiceBandwidthRequests(), ns3::UplinkSchedulerMBQoS::ServiceBandwidthRequests(), ns3::UplinkSchedulerSimple::ServiceUnsolicitedGrants(), ns3::UplinkSchedulerRtps::ServiceUnsolicitedGrants(), and ns3::UplinkSchedulerMBQoS::UplinkSchedWindowTimer().

+ Here is the caller graph for this function:

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

Set the number of received bytes.

Parameters
bytesRcvdthe number of received bytes

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

References m_bytesRcvd.

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

Set the number of sent bytes.

Parameters
bytesSentthe number of sent bytes

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

References m_bytesSent.

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

Set the DlTimeStamp.

Parameters
dlTimeStamp,:time when this service flow's traffic was last sent.

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

References m_dlTimeStamp.

Referenced by ns3::BSSchedulerRtps::BSSchedulerRTPSConnection(), ns3::BSSchedulerRtps::BSSchedulerUGSConnection(), and ns3::BSSchedulerSimple::SelectConnection().

+ Here is the caller graph for this function:

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

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

References m_grantedBandwidth.

Referenced by ns3::UplinkSchedulerSimple::OnSetRequestedBandwidth(), ns3::UplinkSchedulerRtps::OnSetRequestedBandwidth(), and ns3::UplinkSchedulerRtps::ULSchedulerRTPSConnection().

+ Here is the caller graph for this function:

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

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

References m_grantedBandwidthTemp.

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

+ Here is the caller graph for this function:

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 49 of file service-flow-record.cc.

References m_grantSize.

Referenced by ns3::UplinkSchedulerSimple::SetupServiceFlow(), ns3::UplinkSchedulerMBQoS::SetupServiceFlow(), and ns3::UplinkSchedulerRtps::SetupServiceFlow().

+ Here is the caller graph for this function:

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

Set the grant time stamp. Used for data alocation for ugs flows, and unicast poll (bw request) for non-UGS flows.

Parameters
grantTimeStampthe grant time stamp to set

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

References m_grantTimeStamp.

Referenced by ns3::BandwidthManager::CalculateAllocationSize(), ns3::UplinkSchedulerSimple::ServiceUnsolicitedGrants(), and ns3::UplinkSchedulerRtps::ServiceUnsolicitedGrants().

+ Here is the caller graph for this function:

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

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

References m_lastGrantTime.

Referenced by ns3::UplinkSchedulerMBQoS::ServiceBandwidthRequests(), and ns3::UplinkSchedulerMBQoS::ServiceUnsolicitedGrants().

+ Here is the caller graph for this function:

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

Set the number of received packet.

Parameters
pktsRcvdThe number of received packets

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

References m_pktsRcvd.

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 85 of file service-flow-record.cc.

References m_pktsSent.

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

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

References m_requestedBandwidth.

Referenced by ns3::UplinkSchedulerRtps::ULSchedulerRTPSConnection().

+ Here is the caller graph for this function:

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

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

References m_bwSinceLastExpiry.

Referenced by ns3::UplinkSchedulerMBQoS::ServiceBandwidthRequestsBytes(), and ns3::UplinkSchedulerMBQoS::UplinkSchedWindowTimer().

+ Here is the caller graph for this function:

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 145 of file service-flow-record.cc.

References m_bytesRcvd.

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

+ Here is the caller graph for this function:

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 127 of file service-flow-record.cc.

References m_bytesSent.

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

+ Here is the caller graph for this function:

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

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

References m_grantedBandwidth.

Referenced by ns3::UplinkSchedulerSimple::ServiceBandwidthRequests(), ns3::UplinkSchedulerRtps::ServiceBandwidthRequests(), ns3::UplinkSchedulerMBQoS::ServiceBandwidthRequests(), ns3::UplinkSchedulerMBQoS::ServiceBandwidthRequestsBytes(), and ns3::UplinkSchedulerRtps::ULSchedulerRTPSConnection().

+ Here is the caller graph for this function:

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

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

References m_grantedBandwidthTemp.

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

+ Here is the caller graph for this function:

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 109 of file service-flow-record.cc.

References m_pktsRcvd.

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

+ Here is the caller graph for this function:

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 91 of file service-flow-record.cc.

References m_pktsSent.

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

+ Here is the caller graph for this function:

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

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

References m_requestedBandwidth.

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

+ Here is the caller graph for this function:

Member Data Documentation

int32_t ns3::ServiceFlowRecord::m_backlogged
private

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

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

int32_t ns3::ServiceFlowRecord::m_backloggedTemp
private

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

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

uint32_t ns3::ServiceFlowRecord::m_bwSinceLastExpiry
private

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

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

uint32_t ns3::ServiceFlowRecord::m_bytesRcvd
private

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

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

uint32_t ns3::ServiceFlowRecord::m_bytesSent
private

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

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

Time ns3::ServiceFlowRecord::m_dlTimeStamp
private

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

Referenced by GetDlTimeStamp(), and SetDlTimeStamp().

uint32_t ns3::ServiceFlowRecord::m_grantedBandwidth
private

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

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

uint32_t ns3::ServiceFlowRecord::m_grantedBandwidthTemp
private

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

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

uint32_t ns3::ServiceFlowRecord::m_grantSize
private

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

Referenced by GetGrantSize(), and SetGrantSize().

Time ns3::ServiceFlowRecord::m_grantTimeStamp
private

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

Referenced by GetGrantTimeStamp(), and SetGrantTimeStamp().

Time ns3::ServiceFlowRecord::m_lastGrantTime
private

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

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

uint32_t ns3::ServiceFlowRecord::m_pktsRcvd
private

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

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

uint32_t ns3::ServiceFlowRecord::m_pktsSent
private

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

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

uint32_t ns3::ServiceFlowRecord::m_requestedBandwidth
private

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

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

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