A Discrete-Event Network Simulator
API
tcp-rx-buffer.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2010 Adrian Sai-wah Tam
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation;
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 *
17 * Author: Adrian Sai-wah Tam <adrian.sw.tam@gmail.com>
18 */
19
20#ifndef TCP_RX_BUFFER_H
21#define TCP_RX_BUFFER_H
22
23#include "ns3/ptr.h"
24#include "ns3/sequence-number.h"
25#include "ns3/tcp-header.h"
26#include "ns3/tcp-option-sack.h"
27#include "ns3/trace-source-accessor.h"
28#include "ns3/traced-value.h"
29
30#include <map>
31
32namespace ns3
33{
34class Packet;
35
74class TcpRxBuffer : public Object
75{
76 public:
81 static TypeId GetTypeId();
86 TcpRxBuffer(uint32_t n = 0);
87 ~TcpRxBuffer() override;
88
89 // Accessors
103 void IncNextRxSequence();
108 void SetNextRxSequence(const SequenceNumber32& s);
113 void SetFinSequence(const SequenceNumber32& s);
118 uint32_t MaxBufferSize() const;
128 uint32_t Size() const;
133 uint32_t Available() const;
138 bool Finished();
139
151 bool Add(Ptr<Packet> p, const TcpHeader& tcph);
152
161
171
178
183 bool GotFin() const
184 {
185 return m_gotFin;
186 }
187
188 private:
207 void UpdateSackList(const SequenceNumber32& head, const SequenceNumber32& tail);
208
220 void ClearSackList(const SequenceNumber32& seq);
221
223
225 typedef std::map<SequenceNumber32, Ptr<Packet>>::iterator BufIterator;
229 bool m_gotFin;
233 std::map<SequenceNumber32, Ptr<Packet>> m_data;
234};
235
236} // namespace ns3
237
238#endif /* TCP_RX_BUFFER_H */
A base class which provides memory management and object aggregation.
Definition: object.h:89
Header for the Transmission Control Protocol.
Definition: tcp-header.h:46
std::list< SackBlock > SackList
SACK list definition.
Rx reordering buffer for TCP.
Definition: tcp-rx-buffer.h:75
~TcpRxBuffer() override
uint32_t GetSackListSize() const
Get the size of Sack list.
Ptr< Packet > Extract(uint32_t maxSize)
Extract data from the head of the buffer as indicated by nextRxSeq.
bool Finished()
Check if the buffer did receive all the data (and the connection is closed)
static TypeId GetTypeId()
Get the type ID.
void SetFinSequence(const SequenceNumber32 &s)
Set the FIN Sequence number (i.e., the one closing the connection)
void SetMaxBufferSize(uint32_t s)
Set the Maximum buffer size.
SequenceNumber32 NextRxSequence() const
Get Next Rx Sequence number.
std::map< SequenceNumber32, Ptr< Packet > > m_data
Corresponding data (may be null)
void SetNextRxSequence(const SequenceNumber32 &s)
Set the Next Sequence number.
SequenceNumber32 m_finSeq
Seqnum of the FIN packet.
uint32_t m_availBytes
Number of bytes available to read, i.e.
void IncNextRxSequence()
Increment the Next Sequence number.
uint32_t MaxBufferSize() const
Get the Maximum buffer size.
uint32_t Size() const
Get the actual buffer occupancy.
bool Add(Ptr< Packet > p, const TcpHeader &tcph)
Insert a packet into the buffer and update the availBytes counter to reflect the number of bytes read...
uint32_t m_maxBuffer
Upper bound of the number of data bytes in buffer (RCV.WND)
std::map< SequenceNumber32, Ptr< Packet > >::iterator BufIterator
container for data stored in the buffer
SequenceNumber32 MaxRxSequence() const
Get the lowest sequence number that this TcpRxBuffer cannot accept.
bool GotFin() const
Says if a FIN bit has been received.
TracedValue< SequenceNumber32 > m_nextRxSeq
Seqnum of the first missing byte in data (RCV.NXT)
TcpRxBuffer(uint32_t n=0)
Constructor.
void UpdateSackList(const SequenceNumber32 &head, const SequenceNumber32 &tail)
Update the sack list, with the block seq starting at the beginning.
uint32_t Available() const
Get the actual number of bytes available to be read.
TcpOptionSack::SackList GetSackList() const
Get the sack list.
uint32_t m_size
Number of total data bytes in the buffer, not necessarily contiguous.
void ClearSackList(const SequenceNumber32 &seq)
Remove old blocks from the sack list.
bool m_gotFin
Did I received FIN packet?
TcpOptionSack::SackList m_sackList
Sack list (updated constantly)
a unique identifier for an interface.
Definition: type-id.h:60
Every class exported by the ns3 library is enclosed in the ns3 namespace.