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#ifndef TCP_TX_ITEM_H
20#define TCP_TX_ITEM_H
21
22#include "ns3/packet.h"
23#include "ns3/nstime.h"
24#include "ns3/sequence-number.h"
25
26namespace ns3 {
33{
34public:
35 // Default constructor, copy-constructor, destructor
36
42 void Print (std::ostream &os, Time::Unit unit = Time::S) const;
43
49 uint32_t GetSeqSize (void) const;
50
55 bool IsSacked (void) const;
56
61 bool IsRetrans (void) const;
62
67 Ptr<Packet> GetPacketCopy (void) const;
68
73 Ptr<const Packet> GetPacket (void) const;
74
79 const Time & GetLastSent (void) const;
80
88 {
89 uint64_t m_delivered {0};
92 bool m_isAppLimited {false};
93 };
94
100 RateInformation & GetRateInformation (void);
101
102 bool m_retrans {false};
103
104private:
105 // Only TcpTxBuffer is allowed to touch this part of the TcpTxItem, to manage
106 // its internal lists and counters
107 friend class TcpTxBuffer;
108
111 bool m_lost {false};
113 bool m_sacked {false};
114
116};
117
118} //namespace ns3
119
120#endif /* TCP_TX_ITEM_H */
Tcp sender buffer.
Item that encloses the application packet and some flags for it.
Definition: tcp-tx-item.h:33
bool m_sacked
Indicates if the segment has been SACKed.
Definition: tcp-tx-item.h:113
RateInformation & GetRateInformation(void)
Get (to modify) the Rate Information of this item.
Definition: tcp-tx-item.cc:98
bool m_retrans
Indicates if the segment is retransmitted.
Definition: tcp-tx-item.h:102
SequenceNumber32 m_startSeq
Sequence number of the item (if transmitted)
Definition: tcp-tx-item.h:109
Time m_lastSent
Timestamp of the time at which the segment has been sent last time.
Definition: tcp-tx-item.h:112
RateInformation m_rateInfo
Rate information of the item.
Definition: tcp-tx-item.h:115
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
bool IsSacked(void) const
Is the item sacked?
Definition: tcp-tx-item.cc:68
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
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
bool m_lost
Indicates if the segment has been lost (RTO)
Definition: tcp-tx-item.h:111
Ptr< Packet > m_packet
Application packet (can be null)
Definition: tcp-tx-item.h:110
void Print(std::ostream &os, Time::Unit unit=Time::S) const
Print the time.
Definition: tcp-tx-item.cc:24
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:104
Unit
The unit to use to interpret a number representing time.
Definition: nstime.h:110
@ S
second
Definition: nstime.h:115
static Time Max()
Maximum representable Time Not to be confused with Max(Time,Time).
Definition: nstime.h:283
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Various rate-related information, can be accessed by TcpRateOps.
Definition: tcp-tx-item.h:88
bool m_isAppLimited
Connection's app limited at the time the packet was sent.
Definition: tcp-tx-item.h:92
uint64_t m_delivered
Connection's delivered data at the time the packet was sent.
Definition: tcp-tx-item.h:89
Time m_deliveredTime
Connection's delivered time at the time the packet was sent.
Definition: tcp-tx-item.h:90
Time m_firstSent
Connection's first sent time at the time the packet was sent.
Definition: tcp-tx-item.h:91