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

#include "tcp-rx-buffer.h"

Inheritance diagram for ns3::TcpRxBuffer:

Collaboration diagram for ns3::TcpRxBuffer:

Public Types
typedef std::map< SequenceNumber32, Ptr< Packet > >::iterator	BufIterator
	container for data stored in the buffer More...

Public Member Functions
	TcpRxBuffer (uint32_t n=0)
	Constructor. More...

virtual	~TcpRxBuffer ()

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 ready to send to the application. More...

uint32_t	Available () const
	Get the actual number of bytes available to be read. More...

Ptr< Packet >	Extract (uint32_t maxSize)
	Extract data from the head of the buffer as indicated by nextRxSeq. More...

bool	Finished (void)
	Check if the buffer did receive all the data (and the connection is closed) More...

void	IncNextRxSequence (void)
	Increment the Next Sequence number. More...

uint32_t	MaxBufferSize (void) const
	Get the Maximum buffer size. More...

SequenceNumber32	MaxRxSequence (void) const
	Get the lowest sequence number that this TcpRxBuffer cannot accept. More...

SequenceNumber32	NextRxSequence (void) const
	Get Next Rx Sequence number. More...

void	SetFinSequence (const SequenceNumber32 &s)
	Set the FIN Sequence number (i.e., the one closing the connection) More...

void	SetMaxBufferSize (uint32_t s)
	Set the Maximum buffer size. More...

void	SetNextRxSequence (const SequenceNumber32 &s)
	Set the Next Sequence number. More...

uint32_t	Size (void) const
	Get the actual buffer occupancy. More...

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor. More...

virtual	~Object ()
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose (void)
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator (void) const
	Get an iterator to the Objects aggregated to this one. More...

virtual TypeId	GetInstanceTypeId (void) const
	Implement the GetInstanceTypeId method defined in ObjectBase. More...

template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...

void	Initialize (void)
	Invoke DoInitialize on all Objects aggregated to this one. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising erros. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

Static Public Member Functions
static TypeId	GetTypeId (void)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Public Attributes
uint32_t	m_availBytes
	Number of bytes available to read, i.e. More...

std::map< SequenceNumber32, Ptr< Packet > >	m_data
	Corresponding data (may be null) More...

SequenceNumber32	m_finSeq
	Seqnum of the FIN packet. More...

bool	m_gotFin
	Did I received FIN packet? More...

uint32_t	m_maxBuffer
	Upper bound of the number of data bytes in buffer (RCV.WND) More...

TracedValue< SequenceNumber32 >	m_nextRxSeq
	Seqnum of the first missing byte in data (RCV.NXT) More...

uint32_t	m_size
	Number of total data bytes in the buffer, not necessarily contiguous. More...

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. More...

virtual void	DoDispose (void)
	Destructor implementation. More...

virtual void	DoInitialize (void)
	Initialize() implementation. More...

virtual void	NotifyNewAggregate (void)
	Notify all Objects aggregated to this one of a new Object being aggregated. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted (void)
	Notifier called once the ObjectBase is fully constructed. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

class for the reordering buffer that keeps the data from lower layer, i.e.

TcpL4Protocol, sent to the application

Config Paths

ns3::TcpRxBuffer is accessible through the following paths with Config::Set and Config::Connect:

"/NodeList/[i]/$ns3::TcpL4Protocol/SocketList/[i]/RxBuffer"

No Attributes are defined for this type.

TraceSources

NextRxSequence: Next sequence number expected (RCV.NXT)
Callback signature: ns3::SequenceNumber32TracedValueCallback

Size of this type is 128 bytes (on a 64-bit architecture).

Definition at line 40 of file tcp-rx-buffer.h.

Member Typedef Documentation

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

container for data stored in the buffer

Definition at line 129 of file tcp-rx-buffer.h.

Constructor & Destructor Documentation

ns3::TcpRxBuffer::TcpRxBuffer ( uint32_t n = 0 )

Constructor.

Parameters

n	initial Sequence number to be received

Definition at line 54 of file tcp-rx-buffer.cc.

ns3::TcpRxBuffer::~TcpRxBuffer ( )

virtual

Definition at line 59 of file tcp-rx-buffer.cc.

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

Parameters

p	packet
tcph	packet's TCP header

Returns: True when success, false otherwise.

Definition at line 141 of file tcp-rx-buffer.cc.

References ns3::Packet::CreateFragment(), ns3::TcpHeader::GetSequenceNumber(), ns3::Packet::GetSize(), m_availBytes, m_data, m_finSeq, m_gotFin, m_maxBuffer, m_nextRxSeq, m_size, NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_LOGIC, and visualizer.core::start().

Here is the call graph for this function:

uint32_t ns3::TcpRxBuffer::Available ( ) const

Get the actual number of bytes available to be read.

Returns: size of available data (in bytes)

Definition at line 94 of file tcp-rx-buffer.cc.

References m_availBytes.

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.

Parameters

maxSize maximum number of bytes to extract

Returns: a packet

Definition at line 224 of file tcp-rx-buffer.cc.

References m_availBytes, m_data, m_nextRxSeq, m_size, NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

bool ns3::TcpRxBuffer::Finished ( void )

Check if the buffer did receive all the data (and the connection is closed)

Returns: true if all data have been received

Definition at line 135 of file tcp-rx-buffer.cc.

References m_finSeq, m_gotFin, and m_nextRxSeq.

TypeId ns3::TcpRxBuffer::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 33 of file tcp-rx-buffer.cc.

References m_nextRxSeq, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

void ns3::TcpRxBuffer::IncNextRxSequence ( void )

Increment the Next Sequence number.

Definition at line 100 of file tcp-rx-buffer.cc.

References m_nextRxSeq, m_size, NS_ASSERT, and NS_LOG_FUNCTION.

uint32_t ns3::TcpRxBuffer::MaxBufferSize ( void ) const

Get the Maximum buffer size.

Returns: the Maximum buffer size

Definition at line 76 of file tcp-rx-buffer.cc.

References m_maxBuffer.

SequenceNumber32 ns3::TcpRxBuffer::MaxRxSequence ( void ) const

Get the lowest sequence number that this TcpRxBuffer cannot accept.

Returns: the lowest sequence number that this TcpRxBuffer cannot accept

Definition at line 111 of file tcp-rx-buffer.cc.

References m_data, m_finSeq, m_gotFin, m_maxBuffer, and m_nextRxSeq.

SequenceNumber32 ns3::TcpRxBuffer::NextRxSequence ( void ) const

Get Next Rx Sequence number.

Returns: Next Rx Sequence number

Definition at line 64 of file tcp-rx-buffer.cc.

References m_nextRxSeq.

void ns3::TcpRxBuffer::SetFinSequence ( const SequenceNumber32 & s )

Set the FIN Sequence number (i.e., the one closing the connection)

Parameters

s	the Sequence number

Definition at line 125 of file tcp-rx-buffer.cc.

References m_finSeq, m_gotFin, m_nextRxSeq, and NS_LOG_FUNCTION.

void ns3::TcpRxBuffer::SetMaxBufferSize ( uint32_t s )

Set the Maximum buffer size.

Parameters

s	the Maximum buffer size

Definition at line 82 of file tcp-rx-buffer.cc.

References m_maxBuffer.

void ns3::TcpRxBuffer::SetNextRxSequence ( const SequenceNumber32 & s )

Set the Next Sequence number.

Parameters

s	the Sequence number

Definition at line 70 of file tcp-rx-buffer.cc.

References m_nextRxSeq.

uint32_t ns3::TcpRxBuffer::Size ( void ) const

Get the actual buffer occupancy.

Returns: buffer occupancy (in bytes)

Definition at line 88 of file tcp-rx-buffer.cc.

References m_size.

Member Data Documentation

uint32_t ns3::TcpRxBuffer::m_availBytes

Number of bytes available to read, i.e.

contiguous block at head

Definition at line 135 of file tcp-rx-buffer.h.

Referenced by Add(), Available(), and Extract().

std::map<SequenceNumber32, Ptr<Packet> > ns3::TcpRxBuffer::m_data

Corresponding data (may be null)

Definition at line 136 of file tcp-rx-buffer.h.

Referenced by Add(), Extract(), and MaxRxSequence().

SequenceNumber32 ns3::TcpRxBuffer::m_finSeq

Seqnum of the FIN packet.

Definition at line 131 of file tcp-rx-buffer.h.

Referenced by Add(), Finished(), MaxRxSequence(), and SetFinSequence().

bool ns3::TcpRxBuffer::m_gotFin

Did I received FIN packet?

Definition at line 132 of file tcp-rx-buffer.h.

Referenced by Add(), Finished(), MaxRxSequence(), and SetFinSequence().

uint32_t ns3::TcpRxBuffer::m_maxBuffer

Upper bound of the number of data bytes in buffer (RCV.WND)

Definition at line 134 of file tcp-rx-buffer.h.

Referenced by Add(), MaxBufferSize(), MaxRxSequence(), and SetMaxBufferSize().

TracedValue<SequenceNumber32> ns3::TcpRxBuffer::m_nextRxSeq

Seqnum of the first missing byte in data (RCV.NXT)

Definition at line 130 of file tcp-rx-buffer.h.

Referenced by Add(), Extract(), Finished(), GetTypeId(), IncNextRxSequence(), MaxRxSequence(), NextRxSequence(), SetFinSequence(), and SetNextRxSequence().

uint32_t ns3::TcpRxBuffer::m_size

Number of total data bytes in the buffer, not necessarily contiguous.

Definition at line 133 of file tcp-rx-buffer.h.

Referenced by Add(), Extract(), IncNextRxSequence(), and Size().

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

src/internet/model/tcp-rx-buffer.h
src/internet/model/tcp-rx-buffer.cc

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Config Paths

TraceSources

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation