ns3::TcpRxBuffer Class Reference
[Tcp]

class for the reordering buffer that keeps the data from lower layer, i.e. TcpL4Protocol, sent to the application More...

#include <tcp-rx-buffer.h>

Inheritance diagram for ns3::TcpRxBuffer:
Inheritance graph
[legend]
Collaboration diagram for ns3::TcpRxBuffer:
Collaboration graph
[legend]

List of all members.

Public Types

typedef std::map
< SequenceNumber32, Ptr
< Packet > >::iterator 
BufIterator

Public Member Functions

 TcpRxBuffer (uint32_t n=0)
SequenceNumber32 NextRxSequence (void) const
SequenceNumber32 MaxRxSequence (void) const
void IncNextRxSequence (void)
void SetNextRxSequence (const SequenceNumber32 &s)
void SetFinSequence (const SequenceNumber32 &s)
uint32_t MaxBufferSize (void) const
void SetMaxBufferSize (uint32_t s)
uint32_t Size (void) const
uint32_t Available () const
bool Finished (void)
bool Add (Ptr< Packet > p, TcpHeader const &tcph)
Ptr< PacketExtract (uint32_t maxSize)

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::Object.

Public Attributes

TracedValue< SequenceNumber32m_nextRxSeq
SequenceNumber32 m_finSeq
bool m_gotFin
uint32_t m_size
uint32_t m_maxBuffer
uint32_t m_availBytes
std::map< SequenceNumber32,
Ptr< Packet > > 
m_data

Detailed Description

class for the reordering buffer that keeps the data from lower layer, i.e. TcpL4Protocol, sent to the application


Member Function Documentation

bool ns3::TcpRxBuffer::Add ( Ptr< Packet p,
TcpHeader const &  tcph 
)

Insert a packet into the buffer and update the availBytes counter to reflect the number of bytes ready to send to the application. This function handles overlap by triming the head of the inputted packet and removing data from the buffer that overlaps the tail of the inputted packet

Returns:
True when success, false otherwise.
Ptr<Packet> ns3::TcpRxBuffer::Extract ( uint32_t  maxSize  ) 

Extract data from the head of the buffer as indicated by nextRxSeq. The extracted data is going to be forwarded to the application.

static TypeId ns3::TcpRxBuffer::GetTypeId ( void   )  [static]

This method returns the TypeId associated to ns3::Object.

This object is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/LinkManager
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/SSManager
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/ServiceFlowManager
  • /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy
  • /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/Classifier
  • /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/LinkManager
  • /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/SSScheduler
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/NoiseModel
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/PropagationModel
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Mac
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Transducer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/LinkManager
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/SSManager
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/ServiceFlowManager
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/Classifier
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/LinkManager
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/SSScheduler
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BandwidthManager
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BurstProfileManager
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/NoiseModel
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/PropagationModel
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/ConnectionManager
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/NoiseModel
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/PropagationModel

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::Object.


The documentation for this class was generated from the following file:

Generated on 6 Jan 2011 for NS-3 by  doxygen 1.6.1