A Discrete-Event Network Simulator
API
tcp-yeah.h
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2016 ResiliNets, ITTC, University of Kansas
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation;
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 *
18 * Author: Truc Anh N. Nguyen <annguyen@ittc.ku.edu>
19 *
20 * James P.G. Sterbenz <jpgs@ittc.ku.edu>, director
21 * ResiliNets Research Group https://resilinets.org/
22 * Information and Telecommunication Technology Center (ITTC)
23 * and Department of Electrical Engineering and Computer Science
24 * The University of Kansas Lawrence, KS USA.
25 */
26
27#ifndef TCPYEAH_H
28#define TCPYEAH_H
29
30#include "ns3/tcp-scalable.h"
31#include "ns3/tcp-recovery-ops.h"
32
33namespace ns3 {
34
72class TcpYeah : public TcpNewReno
73{
74public:
79 static TypeId GetTypeId (void);
80
84 TcpYeah (void);
85
90 TcpYeah (const TcpYeah& sock);
91 virtual ~TcpYeah (void);
92
93 virtual std::string GetName () const;
94
110 virtual void PktsAcked (Ptr<TcpSocketState> tcb, uint32_t segmentsAcked,
111 const Time& rtt);
112
121 virtual void CongestionStateSet (Ptr<TcpSocketState> tcb,
122 const TcpSocketState::TcpCongState_t newState);
123
130 virtual void IncreaseWindow (Ptr<TcpSocketState> tcb, uint32_t segmentsAcked);
131
141 uint32_t bytesInFlight);
142
143 virtual Ptr<TcpCongestionOps> Fork ();
144
145protected:
146private:
158 void EnableYeah (const SequenceNumber32 &nextTxSequence);
159
163 void DisableYeah ();
164
165private:
173
185};
186
187} // namespace ns3
188
189#endif // TCPYEAH_H
The NewReno implementation.
TcpCongState_t
Definition of the Congestion state machine.
An implementation of TCP YeAH.
Definition: tcp-yeah.h:73
Time m_minRtt
Minimum of all RTTs measured within last RTT.
Definition: tcp-yeah.h:177
uint32_t m_zeta
Minimum number of state switches to reset m_renoCount.
Definition: tcp-yeah.h:172
virtual uint32_t GetSsThresh(Ptr< const TcpSocketState > tcb, uint32_t bytesInFlight)
Get slow start threshold upon the receipt of 3 dupACKs.
Definition: tcp-yeah.cc:316
uint32_t m_renoCount
Estimated cwnd of competing Reno flow.
Definition: tcp-yeah.h:183
virtual void PktsAcked(Ptr< TcpSocketState > tcb, uint32_t segmentsAcked, const Time &rtt)
Compute RTTs needed to execute YeAH algorithm.
Definition: tcp-yeah.cc:141
bool m_doingYeahNow
If true, do YeAH for this RTT.
Definition: tcp-yeah.h:179
virtual Ptr< TcpCongestionOps > Fork()
Copy the congestion control algorithm across sockets.
Definition: tcp-yeah.cc:135
uint32_t m_cntRtt
Number of RTT measurements during last RTT.
Definition: tcp-yeah.h:178
static TypeId GetTypeId(void)
Get the type ID.
Definition: tcp-yeah.cc:37
uint32_t m_lastQ
Last number of packets in the bottleneck queue.
Definition: tcp-yeah.h:181
virtual ~TcpYeah(void)
Definition: tcp-yeah.cc:129
SequenceNumber32 m_begSndNxt
Right edge during last RTT.
Definition: tcp-yeah.h:180
uint32_t m_stcpAiFactor
STCP additive increase parameter.
Definition: tcp-yeah.h:174
Ptr< TcpScalable > m_stcp
TcpScalable object.
Definition: tcp-yeah.h:175
virtual void IncreaseWindow(Ptr< TcpSocketState > tcb, uint32_t segmentsAcked)
Adjust cwnd following YeAH dual-mode algorithm.
Definition: tcp-yeah.cc:198
uint32_t m_alpha
Maximum backlog allowed at the bottleneck queue; Q_max in the paper.
Definition: tcp-yeah.h:166
TcpYeah(void)
Create an unbound tcp socket.
Definition: tcp-yeah.cc:79
uint32_t m_phy
Maximum delta from base.
Definition: tcp-yeah.h:170
uint32_t m_epsilon
Log maximum fraction to be removed on early decongestion.
Definition: tcp-yeah.h:169
void EnableYeah(const SequenceNumber32 &nextTxSequence)
Enable YeAH algorithm to start taking YeAH samples.
Definition: tcp-yeah.cc:163
virtual void CongestionStateSet(Ptr< TcpSocketState > tcb, const TcpSocketState::TcpCongState_t newState)
Enable/disable YeAH algorithm depending on the congestion state.
Definition: tcp-yeah.cc:182
uint32_t m_doingRenoNow
Number of RTTs in "Slow" mode.
Definition: tcp-yeah.h:182
uint32_t m_rho
Minimum number of consecutive RTT to consider competition with Reno flows on loss.
Definition: tcp-yeah.h:171
void DisableYeah()
Stop taking YeAH samples.
Definition: tcp-yeah.cc:174
uint32_t m_fastCount
Number of RTTs in "Fast" mode.
Definition: tcp-yeah.h:184
Time m_baseRtt
Minimum of all YeAH RTT measurements seen during connection.
Definition: tcp-yeah.h:176
uint32_t m_gamma
Fraction of queue to be removed per RTT when precautionary decongestion executed.
Definition: tcp-yeah.h:167
uint32_t m_delta
Log minimum fraction of cwnd to be removed on loss.
Definition: tcp-yeah.h:168
virtual std::string GetName() const
Get the name of the congestion control algorithm.
Definition: tcp-yeah.cc:310
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:104
a unique identifier for an interface.
Definition: type-id.h:59
Every class exported by the ns3 library is enclosed in the ns3 namespace.