Defines the TCP option of kind 5 (selective acknowledgment option) as in RFC 2018 More...

#include "tcp-option-sack.h"

Inheritance diagram for ns3::TcpOptionSack:

Collaboration diagram for ns3::TcpOptionSack:

Public Types
typedef std::pair< SequenceNumber32, SequenceNumber32 >	SackBlock
	SACK block definition.

typedef std::list< SackBlock >	SackList
	SACK list definition.

Public Types inherited from ns3::TcpOption
enum	Kind { END = 0 , NOP = 1 , MSS = 2 , WINSCALE = 3 , SACKPERMITTED = 4 , SACK = 5 , TS = 8 , UNKNOWN = 255 }
	The option Kind, as defined in the respective RFCs. More...

Public Member Functions
	TcpOptionSack ()

	~TcpOptionSack () override

void	AddSackBlock (SackBlock s)
	Add a SACK block.

void	ClearSackList ()
	Clear the SACK list.

uint32_t	Deserialize (Buffer::Iterator start) override
	Deserialize the Option from a buffer iterator.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

uint8_t	GetKind () const override
	Get the ‘kind’ (as in RFC 793 ) of this option.

uint32_t	GetNumSackBlocks () const
	Count the total number of SACK blocks.

SackList	GetSackList () const
	Get the SACK list.

uint32_t	GetSerializedSize () const override
	Returns number of bytes required for Option serialization.

void	Print (std::ostream &os) const override
	Print the Option contents.

void	Serialize (Buffer::Iterator start) const override
	Serialize the Option to a buffer iterator.

Public Member Functions inherited from ns3::TcpOption
	TcpOption ()

	~TcpOption () override

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

	~Object () override
	Destructor.

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

void	Dispose ()
	Dispose of this Object.

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

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

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

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

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

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

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

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

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

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

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

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

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

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

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

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

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

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

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

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

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

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

Static Public Member Functions inherited from ns3::TcpOption
static Ptr< TcpOption >	CreateOption (uint8_t kind)
	Creates an option.

static TypeId	GetTypeId ()
	Get the type ID.

static bool	IsKindKnown (uint8_t kind)
	Check if the option is implemented.

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

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

Protected Attributes
SackList	m_sackList
	the list of SACK blocks

Friends
std::ostream &	operator<< (std::ostream &os, const TcpOptionSack &sackOption)
	Output operator.

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

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

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

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

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

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

Detailed Description

Defines the TCP option of kind 5 (selective acknowledgment option) as in RFC 2018

TCP SACK Option is used by a receiver to report non-contiguous blocks of data that have been received and queued in the receiving buffer. Using the information conveyed in SACK option sender retransmits only the segments that have actually been lost, allowing the recovery of multiple packet losses per sending window.

Each SACK block is defined by two 32-bit unsigned integers specifying the left and the right edge of the block. It means that with the 40-byte TCP option limitation in addition to the presence of TCP Timestamp Option, the maximum number of SACK blocks that can be appended to each segment is 3.

Definition at line 39 of file tcp-option-sack.h.

Member Typedef Documentation

◆ SackBlock

typedef std::pair<SequenceNumber32, SequenceNumber32> ns3::TcpOptionSack::SackBlock

SACK block definition.

Definition at line 49 of file tcp-option-sack.h.

◆ SackList

typedef std::list<SackBlock> ns3::TcpOptionSack::SackList

SACK list definition.

Definition at line 50 of file tcp-option-sack.h.

Constructor & Destructor Documentation

◆ TcpOptionSack()

ns3::TcpOptionSack::TcpOptionSack ( )

Definition at line 25 of file tcp-option-sack.cc.

◆ ~TcpOptionSack()

ns3::TcpOptionSack::~TcpOptionSack ( )

override

Definition at line 30 of file tcp-option-sack.cc.

Member Function Documentation

◆ AddSackBlock()

void ns3::TcpOptionSack::AddSackBlock ( SackBlock s )

Add a SACK block.

Parameters

s	the SACK block to be added

Definition at line 121 of file tcp-option-sack.cc.

References m_sackList, and NS_LOG_FUNCTION.

Referenced by Deserialize().

Here is the caller graph for this function:

◆ ClearSackList()

void ns3::TcpOptionSack::ClearSackList ( )

Clear the SACK list.

Definition at line 136 of file tcp-option-sack.cc.

References m_sackList.

◆ Deserialize()

uint32_t ns3::TcpOptionSack::Deserialize ( Buffer::Iterator start )

overridevirtual

Deserialize the Option from a buffer iterator.

Parameters

start the buffer iterator

Returns: the number of deserialized bytes

Implements ns3::TcpOption.

Definition at line 87 of file tcp-option-sack.cc.

References AddSackBlock(), GetKind(), GetSerializedSize(), m_sackList, NS_LOG_FUNCTION, NS_LOG_LOGIC, NS_LOG_WARN, ns3::Buffer::Iterator::ReadNtohU32(), and ns3::Buffer::Iterator::ReadU8().

Here is the call graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::TcpOptionSack::GetInstanceTypeId ( ) const

overridevirtual

Get the most derived TypeId for this Object.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Returns: The TypeId associated to the most-derived type of this instance.

Reimplemented from ns3::TcpOption.

Definition at line 45 of file tcp-option-sack.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetKind()

uint8_t ns3::TcpOptionSack::GetKind ( ) const

overridevirtual

Get the ‘kind’ (as in RFC 793 ) of this option.

Returns: the Option Kind

Implements ns3::TcpOption.

Definition at line 115 of file tcp-option-sack.cc.

References ns3::TcpOption::SACK.

Referenced by Deserialize(), and Serialize().

Here is the caller graph for this function:

◆ GetNumSackBlocks()

uint32_t ns3::TcpOptionSack::GetNumSackBlocks ( ) const

Count the total number of SACK blocks.

Returns: the total number of SACK blocks

Definition at line 128 of file tcp-option-sack.cc.

References m_sackList, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by GetSerializedSize(), Print(), and Serialize().

Here is the caller graph for this function:

◆ GetSackList()

TcpOptionSack::SackList ns3::TcpOptionSack::GetSackList ( ) const

Get the SACK list.

Returns: the SACK list

Definition at line 142 of file tcp-option-sack.cc.

References m_sackList, and NS_LOG_FUNCTION.

◆ GetSerializedSize()

uint32_t ns3::TcpOptionSack::GetSerializedSize ( ) const

overridevirtual

Returns number of bytes required for Option serialization.

Returns: number of bytes required for Option serialization

Implements ns3::TcpOption.

Definition at line 61 of file tcp-option-sack.cc.

References GetNumSackBlocks(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by Deserialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::TcpOptionSack::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 35 of file tcp-option-sack.cc.

References ns3::TypeId::SetParent().

Referenced by ns3::TcpOption::CreateOption(), and GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Print()

void ns3::TcpOptionSack::Print ( std::ostream & os ) const

overridevirtual

Print the Option contents.

Parameters

os	the output stream

Implements ns3::TcpOption.

Definition at line 51 of file tcp-option-sack.cc.

References GetNumSackBlocks(), and m_sackList.

Here is the call graph for this function:

◆ Serialize()

void ns3::TcpOptionSack::Serialize ( Buffer::Iterator start ) const

overridevirtual

Serialize the Option to a buffer iterator.

Parameters

start the buffer iterator

Implements ns3::TcpOption.

Definition at line 69 of file tcp-option-sack.cc.

References GetKind(), GetNumSackBlocks(), ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::GetValue(), m_sackList, NS_LOG_FUNCTION, ns3::Buffer::Iterator::WriteHtonU32(), and ns3::Buffer::Iterator::WriteU8().

Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		const TcpOptionSack &	sackOption )

friend

Output operator.

Parameters

os	The output stream.
sackOption	the option to print.

Returns: The output stream.

Definition at line 148 of file tcp-option-sack.cc.

Member Data Documentation

◆ m_sackList

SackList ns3::TcpOptionSack::m_sackList

protected

the list of SACK blocks

Definition at line 88 of file tcp-option-sack.h.

Referenced by AddSackBlock(), ClearSackList(), Deserialize(), GetNumSackBlocks(), GetSackList(), Print(), and Serialize().

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

src/internet/model/tcp-option-sack.h
src/internet/model/tcp-option-sack.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ SackBlock

◆ SackList

Constructor & Destructor Documentation

◆ TcpOptionSack()

◆ ~TcpOptionSack()

Member Function Documentation

◆ AddSackBlock()

◆ ClearSackList()

◆ Deserialize()

◆ GetInstanceTypeId()

◆ GetKind()

◆ GetNumSackBlocks()

◆ GetSackList()

◆ GetSerializedSize()

◆ GetTypeId()

◆ Print()

◆ Serialize()

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation

◆ m_sackList