A Discrete-Event Network Simulator
API
service-flow-record.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2007,2008 INRIA
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation;
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  *
17  * Author: Jahanzeb Farooq <jahanzeb.farooq@sophia.inria.fr>
18  */
19 
20 #ifndef SERVICE_FLOW_RECORD_H
21 #define SERVICE_FLOW_RECORD_H
22 
23 #include "bs-net-device.h"
24 #include "bs-uplink-scheduler.h"
25 
26 #include "ns3/nstime.h"
27 #include "ns3/ptr.h"
28 
29 #include <stdint.h>
30 
31 namespace ns3
32 {
33 
40 {
41  public:
44 
49  void SetGrantSize(uint32_t grantSize);
53  uint32_t GetGrantSize() const;
59  void SetGrantTimeStamp(Time grantTimeStamp);
64  Time GetGrantTimeStamp() const;
69  void SetDlTimeStamp(Time dlTimeStamp);
73  Time GetDlTimeStamp() const;
78  void SetPktsSent(uint32_t pktsSent);
83  void UpdatePktsSent(uint32_t pktsSent);
87  uint32_t GetPktsSent() const;
92  void SetPktsRcvd(uint32_t pktsRcvd);
97  void UpdatePktsRcvd(uint32_t pktsRcvd);
101  uint32_t GetPktsRcvd() const;
106  void SetBytesSent(uint32_t bytesSent);
111  void UpdateBytesSent(uint32_t bytesSent);
115  uint32_t GetBytesSent() const;
120  void SetBytesRcvd(uint32_t bytesRcvd);
125  void UpdateBytesRcvd(uint32_t bytesRcvd);
129  uint32_t GetBytesRcvd() const;
130 
135  void SetRequestedBandwidth(uint32_t requestedBandwidth);
140  void UpdateRequestedBandwidth(uint32_t requestedBandwidth);
144  uint32_t GetRequestedBandwidth() const;
145 
150  void SetGrantedBandwidth(uint32_t grantedBandwidth);
155  void UpdateGrantedBandwidth(uint32_t grantedBandwidth);
159  uint32_t GetGrantedBandwidth() const;
160 
165  void SetGrantedBandwidthTemp(uint32_t grantedBandwidthTemp);
170  void UpdateGrantedBandwidthTemp(uint32_t grantedBandwidthTemp);
174  uint32_t GetGrantedBandwidthTemp() const;
175 
180  void SetBwSinceLastExpiry(uint32_t bwSinceLastExpiry);
185  void UpdateBwSinceLastExpiry(uint32_t bwSinceLastExpiry);
189  uint32_t GetBwSinceLastExpiry() const;
190 
195  void SetLastGrantTime(Time grantTime);
199  Time GetLastGrantTime() const;
200 
205  void SetBacklogged(uint32_t backlogged);
210  void IncreaseBacklogged(uint32_t backlogged);
214  uint32_t GetBacklogged() const;
215 
220  void SetBackloggedTemp(uint32_t backloggedTemp);
225  void IncreaseBackloggedTemp(uint32_t backloggedTemp);
229  uint32_t GetBackloggedTemp() const;
230 
231  private:
232  uint32_t m_grantSize;
236 
237  // stats members
238  uint32_t m_pktsSent;
239  uint32_t m_pktsRcvd;
240 
241  uint32_t m_bytesSent;
242  uint32_t m_bytesRcvd;
243 
248 
253  int32_t m_backlogged;
255 };
256 
257 } // namespace ns3
258 
259 #endif /* SERVICE_FLOW_RECORD_H */
this class implements a structure to manage some parameters and statistics related to a service flow
uint32_t GetBacklogged() const
uint32_t GetPktsSent() const
void UpdateRequestedBandwidth(uint32_t requestedBandwidth)
update the requested bandwidth
void UpdateBytesRcvd(uint32_t bytesRcvd)
update the number of received bytes by adding bytesRcvd
void UpdatePktsSent(uint32_t pktsSent)
update the number of sent packets by adding pktsSent
int32_t m_backlogged
back logged
void SetPktsRcvd(uint32_t pktsRcvd)
Set the number of received packets.
void UpdateGrantedBandwidthTemp(uint32_t grantedBandwidthTemp)
update the temporary granted bandwidth
uint32_t GetRequestedBandwidth() const
void UpdateBytesSent(uint32_t bytesSent)
update the number of sent bytes by adding bytesSent
uint32_t m_pktsRcvd
packets received
void SetRequestedBandwidth(uint32_t requestedBandwidth)
set the requested bandwidth
uint32_t m_bytesRcvd
bytes received
void IncreaseBacklogged(uint32_t backlogged)
increase backlogged
void SetDlTimeStamp(Time dlTimeStamp)
Set the DlTimeStamp.
uint32_t GetBackloggedTemp() const
void SetBackloggedTemp(uint32_t backloggedTemp)
set temporary back logged
void SetPktsSent(uint32_t pktsSent)
set the number of sent packets in this service flow
uint32_t GetGrantedBandwidthTemp() const
Time m_lastGrantTime
last grant time
uint32_t m_grantedBandwidthTemp
Temporary variable used to sort list.
uint32_t m_pktsSent
packets sent
void SetGrantSize(uint32_t grantSize)
Set the grant size (only for UGS service flows)
uint32_t GetGrantedBandwidth() const
void SetGrantedBandwidthTemp(uint32_t grantedBandwidthTemp)
set the temporary granted bandwidth
uint32_t m_grantedBandwidth
granted badnwidth
void IncreaseBackloggedTemp(uint32_t backloggedTemp)
increase temporary back logged
void UpdatePktsRcvd(uint32_t pktsRcvd)
update the number of received packets by adding pktsRcvd
void SetBwSinceLastExpiry(uint32_t bwSinceLastExpiry)
set BW since last expiry
uint32_t m_requestedBandwidth
requested bandwidth
void UpdateGrantedBandwidth(uint32_t grantedBandwidth)
update the granted bandwidth
void SetBytesRcvd(uint32_t bytesRcvd)
Set the number of received bytes.
uint32_t m_bwSinceLastExpiry
bandwidth granted since last expiry of minimum reserved traffic rate interval, only for nrtPS,...
void UpdateBwSinceLastExpiry(uint32_t bwSinceLastExpiry)
update BW since last expiry
void SetBacklogged(uint32_t backlogged)
set backlogged
uint32_t m_bytesSent
bytes sent
void SetBytesSent(uint32_t bytesSent)
Set the number of sent bytes.
uint32_t GetBwSinceLastExpiry() const
Time m_dlTimeStamp
time when this service flow's traffic was last sent
void SetLastGrantTime(Time grantTime)
set last grant time
uint32_t GetGrantSize() const
void SetGrantTimeStamp(Time grantTimeStamp)
Set the grant time stamp.
void SetGrantedBandwidth(uint32_t grantedBandwidth)
set the granted bandwidth
int32_t m_backloggedTemp
back logged temp
Time m_grantTimeStamp
allocation (for data) for UGS flows and unicast poll (for bandwidth requests) for non-UGS flows
uint32_t m_grantSize
only used for UGS flow
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
Every class exported by the ns3 library is enclosed in the ns3 namespace.