A Discrete-Event Network Simulator
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2010 Adrian Sai-wah Tam
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
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: Adrian Sai-wah Tam <adrian.sw.tam@gmail.com>
19  */
21 #ifndef TCP_RX_BUFFER_H
22 #define TCP_RX_BUFFER_H
24 #include <map>
25 #include "ns3/traced-value.h"
26 #include "ns3/trace-source-accessor.h"
27 #include "ns3/sequence-number.h"
28 #include "ns3/ptr.h"
29 #include "ns3/tcp-header.h"
30 #include "ns3/tcp-option-sack.h"
32 namespace ns3 {
33 class Packet;
73 class TcpRxBuffer : public Object
74 {
75 public:
80  static TypeId GetTypeId (void);
85  TcpRxBuffer (uint32_t n = 0);
86  virtual ~TcpRxBuffer ();
88  // Accessors
93  SequenceNumber32 NextRxSequence (void) const;
98  SequenceNumber32 MaxRxSequence (void) const;
102  void IncNextRxSequence (void);
107  void SetNextRxSequence (const SequenceNumber32& s);
112  void SetFinSequence (const SequenceNumber32& s);
117  uint32_t MaxBufferSize (void) const;
122  void SetMaxBufferSize (uint32_t s);
127  uint32_t Size (void) const;
132  uint32_t Available () const;
137  bool Finished (void);
150  bool Add (Ptr<Packet> p, TcpHeader const& tcph);
159  Ptr<Packet> Extract (uint32_t maxSize);
176  uint32_t GetSackListSize () const;
182  bool GotFin () const { return m_gotFin; }
184 private:
203  void UpdateSackList (const SequenceNumber32 &head, const SequenceNumber32 &tail);
216  void ClearSackList (const SequenceNumber32 &seq);
221  typedef std::map<SequenceNumber32, Ptr<Packet> >::iterator BufIterator;
224  bool m_gotFin;
225  uint32_t m_size;
226  uint32_t m_maxBuffer;
227  uint32_t m_availBytes;
228  std::map<SequenceNumber32, Ptr<Packet> > m_data;
229 };
231 } //namespace ns3
233 #endif /* TCP_RX_BUFFER_H */
uint32_t m_availBytes
Number of bytes available to read, i.e.
uint32_t m_maxBuffer
Upper bound of the number of data bytes in buffer (RCV.WND)
SequenceNumber32 NextRxSequence(void) const
Get Next Rx Sequence number.
bool Add(Ptr< Packet > p, TcpHeader const &tcph)
Insert a packet into the buffer and update the availBytes counter to reflect the number of bytes read...
TracedValue< SequenceNumber32 > m_nextRxSeq
Seqnum of the first missing byte in data (RCV.NXT)
bool GotFin() const
Says if a FIN bit has been received.
std::list< SackBlock > SackList
SACK list definition.
void SetFinSequence(const SequenceNumber32 &s)
Set the FIN Sequence number (i.e., the one closing the connection)
SequenceNumber32 MaxRxSequence(void) const
Get the lowest sequence number that this TcpRxBuffer cannot accept.
void ClearSackList(const SequenceNumber32 &seq)
Remove old blocks from the sack list.
uint32_t GetSackListSize() const
Get the size of Sack list.
void IncNextRxSequence(void)
Increment the Next Sequence number.
bool m_gotFin
Did I received FIN packet?
void UpdateSackList(const SequenceNumber32 &head, const SequenceNumber32 &tail)
Update the sack list, with the block seq starting at the beginning.
Rx reordering buffer for TCP.
Definition: tcp-rx-buffer.h:73
void SetNextRxSequence(const SequenceNumber32 &s)
Set the Next Sequence number.
void SetMaxBufferSize(uint32_t s)
Set the Maximum buffer size.
uint32_t Size(void) const
Get the actual buffer occupancy.
TcpRxBuffer(uint32_t n=0)
SequenceNumber32 m_finSeq
Seqnum of the FIN packet.
Ptr< Packet > Extract(uint32_t maxSize)
Extract data from the head of the buffer as indicated by nextRxSeq.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Header for the Transmission Control Protocol.
Definition: tcp-header.h:44
std::map< SequenceNumber32, Ptr< Packet > > m_data
Corresponding data (may be null)
uint32_t m_size
Number of total data bytes in the buffer, not necessarily contiguous.
TcpOptionSack::SackList m_sackList
Sack list (updated constantly)
static TypeId GetTypeId(void)
Get the type ID.
A base class which provides memory management and object aggregation.
Definition: object.h:87
a unique identifier for an interface.
Definition: type-id.h:58
virtual ~TcpRxBuffer()
uint32_t MaxBufferSize(void) const
Get the Maximum buffer size.
bool Finished(void)
Check if the buffer did receive all the data (and the connection is closed)
uint32_t Available() const
Get the actual number of bytes available to be read.
std::map< SequenceNumber32, Ptr< Packet > >::iterator BufIterator
container for data stored in the buffer
TcpOptionSack::SackList GetSackList() const
Get the sack list.