Defines the TCP option of kind 3 (window scale option) as in RFC 1323 More...

#include "tcp-option-winscale.h"

Inheritance diagram for ns3::TcpOptionWinScale:

Collaboration diagram for ns3::TcpOptionWinScale:

Public Member Functions
	TcpOptionWinScale ()

virtual	~TcpOptionWinScale ()

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

virtual TypeId	GetInstanceTypeId (void) const
	Get the most derived TypeId for this Object. More...

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

uint8_t	GetScale (void) const
	Get the scale value (uint8_t) More...

virtual uint32_t	GetSerializedSize (void) const
	Returns number of bytes required for Option serialization. More...

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

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

void	SetScale (uint8_t scale)
	Set the scale option. More...

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

virtual	~TcpOption ()

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...

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

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

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

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

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

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

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

	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...

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

SimpleRefCount &	operator= ([[maybe_unused]] const SimpleRefCount &o)
	Assignment operator. 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::TcpOption
static Ptr< TcpOption >	CreateOption (uint8_t kind)
	Creates an option. More...

static TypeId	GetTypeId (void)
	Get the type ID. More...

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

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

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

Protected Attributes
uint8_t	m_scale
	Window scaling in number of bit shift. More...

Additional Inherited Members
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...

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

Defines the TCP option of kind 3 (window scale option) as in RFC 1323

Introspection did not find any typical Config paths.

For more efficient use of high bandwidth networks, a larger TCP window size may be used. The TCP window size field controls the flow of data and its value is limited to between 2 and 65,535 bytes.

Since the size field cannot be expanded, a scaling factor is used. The TCP window scale option, as defined in RFC 1323, is an option used to increase the maximum window size from 65,535 bytes to 1 gigabyte. Scaling up to larger window sizes is a part of what is necessary for TCP Tuning.

The window scale option is used only during the TCP 3-way handshake. The window scale value represents the number of bits to left-shift the 16-bit window size field. The window scale value can be set from 0 (no shift) to 14 for each direction independently. Both sides must send the option in their SYN segments to enable window scaling in either direction.

No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 32 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ TcpOptionWinScale()

ns3::TcpOptionWinScale::TcpOptionWinScale ( )

Definition at line 31 of file tcp-option-winscale.cc.

◆ ~TcpOptionWinScale()

ns3::TcpOptionWinScale::~TcpOptionWinScale ( )

virtual

Definition at line 37 of file tcp-option-winscale.cc.

Member Function Documentation

◆ Deserialize()

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

virtual

Deserialize the Option from a buffer iterator.

Parameters

start the buffer iterator

Returns: the number of deserialized bytes

Implements ns3::TcpOption.

Definition at line 80 of file tcp-option-winscale.cc.

References GetKind(), GetSerializedSize(), m_scale, NS_LOG_WARN, ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

Referenced by TcpOptionWSTestCase::TestDeserialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::TcpOptionWinScale::GetInstanceTypeId ( void ) const

virtual

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.