A Discrete-Event Network Simulator
API
tcp-tx-item.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2018 Natale Patriciello <natale.patriciello@gmail.com>
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  */
19 #pragma once
20 
21 #include "ns3/packet.h"
22 #include "ns3/nstime.h"
23 #include "ns3/sequence-number.h"
24 
25 namespace ns3 {
31 class TcpTxItem
32 {
33 public:
34  // Default constructor, copy-constructor, destructor
35 
40  void Print (std::ostream &os) const;
41 
47  uint32_t GetSeqSize (void) const;
48 
53  bool IsSacked (void) const;
54 
59  bool IsRetrans (void) const;
60 
65  Ptr<Packet> GetPacketCopy (void) const;
66 
71  Ptr<const Packet> GetPacket (void) const;
72 
77  const Time & GetLastSent (void) const;
78 
86  {
87  uint64_t m_delivered {0};
90  bool m_isAppLimited {false};
91  };
92 
98  RateInformation & GetRateInformation (void);
99 
100 private:
101  // Only TcpTxBuffer is allower to touch this part of the TcpTxItem, to manage
102  // its internal lists and counters
103  friend class TcpTxBuffer;
104 
106  Ptr<Packet> m_packet {nullptr};
107  bool m_lost {false};
108  bool m_retrans {false};
110  bool m_sacked {false};
111 
113 };
114 
115 } //namespace ns3
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
bool m_retrans
Indicates if the segment is retransmitted.
Definition: tcp-tx-item.h:108
uint32_t GetSeqSize(void) const
Get the size in the sequence number space.
Definition: tcp-tx-item.cc:62
bool IsRetrans(void) const
Is the item retransmitted?
Definition: tcp-tx-item.cc:74
static Time Max()
Maximum representable Time.
Definition: nstime.h:273
Item that encloses the application packet and some flags for it.
Definition: tcp-tx-item.h:31
Time m_lastSent
Timestamp of the time at which the segment has been sent last time.
Definition: tcp-tx-item.h:109
uint64_t m_delivered
Connection&#39;s delivered data at the time the packet was sent.
Definition: tcp-tx-item.h:87
SequenceNumber32 m_startSeq
Sequence number of the item (if transmitted)
Definition: tcp-tx-item.h:105
bool m_isAppLimited
Connection&#39;s app limited at the time the packet was sent.
Definition: tcp-tx-item.h:90
RateInformation & GetRateInformation(void)
Get (to modify) the Rate Information of this item.
Definition: tcp-tx-item.cc:98
bool IsSacked(void) const
Is the item sacked?
Definition: tcp-tx-item.cc:68
Time m_firstSent
Connection&#39;s first sent time at the time the packet was sent.
Definition: tcp-tx-item.h:89
Tcp sender buffer.
RateInformation m_rateInfo
Rate information of the item.
Definition: tcp-tx-item.h:112
Various rate-related information, can be accessed by TcpRateOps.
Definition: tcp-tx-item.h:85
Ptr< Packet > m_packet
Application packet (can be null)
Definition: tcp-tx-item.h:106
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Ptr< const Packet > GetPacket(void) const
Get the Packet underlying this item.
Definition: tcp-tx-item.cc:86
Ptr< Packet > GetPacketCopy(void) const
Get a copy of the Packet underlying this item.
Definition: tcp-tx-item.cc:80
Time m_deliveredTime
Connection&#39;s delivered time at the time the packet was sent.
Definition: tcp-tx-item.h:88
const Time & GetLastSent(void) const
Get a reference to the time the packet was sent for the last time.
Definition: tcp-tx-item.cc:92
bool m_sacked
Indicates if the segment has been SACKed.
Definition: tcp-tx-item.h:110
void Print(std::ostream &os) const
Print the time.
Definition: tcp-tx-item.cc:24
bool m_lost
Indicates if the segment has been lost (RTO)
Definition: tcp-tx-item.h:107