tcp-tx-item.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2018 Natale Patriciello <natale.patriciello@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */
#ifndef TCP_TX_ITEM_H
#define TCP_TX_ITEM_H

#include "ns3/packet.h"
#include "ns3/nstime.h"
#include "ns3/sequence-number.h"

namespace ns3 {
class TcpTxItem
{
public:
  // Default constructor, copy-constructor, destructor

  void Print (std::ostream &os, Time::Unit unit = Time::S) const;

  uint32_t GetSeqSize (void) const;

  bool IsSacked (void) const;

  bool IsRetrans (void) const;

  Ptr<Packet> GetPacketCopy (void) const;

  Ptr<const Packet> GetPacket (void) const;

  const Time & GetLastSent (void) const;

  struct RateInformation
  {
    uint64_t m_delivered {0};          
    Time m_deliveredTime {Time::Max ()};
    Time m_firstSent     {Time::Max ()};
    bool m_isAppLimited  {false};      
  };

  RateInformation & GetRateInformation (void);

  bool m_retrans       {false};      

private:
  // Only TcpTxBuffer is allower to touch this part of the TcpTxItem, to manage
  // its internal lists and counters
  friend class TcpTxBuffer;

  SequenceNumber32 m_startSeq {0};   
  Ptr<Packet> m_packet {nullptr};    
  bool m_lost          {false};      
  Time m_lastSent      {Time::Max ()};
  bool m_sacked        {false};      

  RateInformation m_rateInfo;        
};

} //namespace ns3

#endif /* TCP_TX_ITEM_H */