Base class for all kinds of TCP options. More...

#include "tcp-option.h"

Inheritance diagram for ns3::TcpOption:

Collaboration diagram for ns3::TcpOption:

Public Types
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
	TcpOption ()

	~TcpOption () override

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

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

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

virtual uint32_t	GetSerializedSize () const =0
	Returns number of bytes required for Option serialization.

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

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

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

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

Base class for all kinds of TCP options.

Introspection did not find any typical Config paths.

No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Internet

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

Definition at line 26 of file tcp-option.h.

Member Enumeration Documentation

◆ Kind

enum ns3::TcpOption::Kind

The option Kind, as defined in the respective RFCs.

Enumerator
END	END.
NOP	NOP.
MSS	MSS.
WINSCALE	WINSCALE.
SACKPERMITTED	SACKPERMITTED.
SACK	SACK.
TS	TS.
UNKNOWN	not a standardized value; for unknown recv'd options

Definition at line 43 of file tcp-option.h.

Constructor & Destructor Documentation

◆ TcpOption()

ns3::TcpOption::TcpOption ( )

Definition at line 29 of file tcp-option.cc.

◆ ~TcpOption()

ns3::TcpOption::~TcpOption ( )

override

Definition at line 33 of file tcp-option.cc.

Member Function Documentation

◆ CreateOption()

Ptr< TcpOption > ns3::TcpOption::CreateOption ( uint8_t kind )

static

Creates an option.

Parameters

kind	the option kind

Returns: the requested option or an ns3::UnknownOption if the option is not supported

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

References ns3::ObjectFactory::Create(), ns3::CreateObject(), END, ns3::TcpOptionEnd::GetTypeId(), ns3::TcpOptionMSS::GetTypeId(), ns3::TcpOptionNOP::GetTypeId(), ns3::TcpOptionSack::GetTypeId(), ns3::TcpOptionSackPermitted::GetTypeId(), ns3::TcpOptionTS::GetTypeId(), ns3::TcpOptionUnknown::GetTypeId(), ns3::TcpOptionWinScale::GetTypeId(), MSS, NOP, SACK, SACKPERMITTED, ns3::ObjectFactory::SetTypeId(), TS, UNKNOWN, and WINSCALE.

Referenced by ns3::TcpHeader::Deserialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Deserialize()

virtual uint32_t ns3::TcpOption::Deserialize ( Buffer::Iterator start )

pure virtual

Deserialize the Option from a buffer iterator.

Parameters

start the buffer iterator

Returns: the number of deserialized bytes

Implemented in ns3::TcpOptionEnd, ns3::TcpOptionMSS, ns3::TcpOptionNOP, ns3::TcpOptionSack, ns3::TcpOptionSackPermitted, ns3::TcpOptionTS, ns3::TcpOptionUnknown, and ns3::TcpOptionWinScale.

◆ GetInstanceTypeId()

TypeId ns3::TcpOption::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::Object.

Reimplemented in ns3::TcpOptionEnd, ns3::TcpOptionMSS, ns3::TcpOptionNOP, ns3::TcpOptionSack, ns3::TcpOptionSackPermitted, ns3::TcpOptionTS, ns3::TcpOptionUnknown, and ns3::TcpOptionWinScale.

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

References GetTypeId().

Here is the call graph for this function:

◆ GetKind()

virtual uint8_t ns3::TcpOption::GetKind ( ) const

pure virtual

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

Returns: the Option Kind

Implemented in ns3::TcpOptionEnd, ns3::TcpOptionMSS, ns3::TcpOptionNOP, ns3::TcpOptionSack, ns3::TcpOptionSackPermitted, ns3::TcpOptionTS, ns3::TcpOptionUnknown, and ns3::TcpOptionWinScale.

◆ GetSerializedSize()

virtual uint32_t ns3::TcpOption::GetSerializedSize ( ) const

pure virtual

Returns number of bytes required for Option serialization.

Returns: number of bytes required for Option serialization

Implemented in ns3::TcpOptionEnd, ns3::TcpOptionMSS, ns3::TcpOptionNOP, ns3::TcpOptionSack, ns3::TcpOptionSackPermitted, ns3::TcpOptionTS, ns3::TcpOptionUnknown, and ns3::TcpOptionWinScale.

◆ GetTypeId()

TypeId ns3::TcpOption::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 38 of file tcp-option.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsKindKnown()

bool ns3::TcpOption::IsKindKnown ( uint8_t kind )

static

Check if the option is implemented.

Parameters

kind	the Option kind

Returns: true if the option is known

Definition at line 84 of file tcp-option.cc.

References END, MSS, NOP, SACK, SACKPERMITTED, TS, and WINSCALE.

Referenced by ns3::TcpHeader::AppendOption(), and ns3::TcpHeader::Deserialize().

Here is the caller graph for this function:

◆ Print()

virtual void ns3::TcpOption::Print ( std::ostream & os ) const

pure virtual

Print the Option contents.

Parameters

os	the output stream

Implemented in ns3::TcpOptionEnd, ns3::TcpOptionMSS, ns3::TcpOptionNOP, ns3::TcpOptionSack, ns3::TcpOptionSackPermitted, ns3::TcpOptionTS, ns3::TcpOptionUnknown, and ns3::TcpOptionWinScale.

◆ Serialize()

virtual void ns3::TcpOption::Serialize ( Buffer::Iterator start ) const

pure virtual

Serialize the Option to a buffer iterator.

Parameters

start the buffer iterator

Implemented in ns3::TcpOptionEnd, ns3::TcpOptionMSS, ns3::TcpOptionNOP, ns3::TcpOptionSack, ns3::TcpOptionSackPermitted, ns3::TcpOptionTS, ns3::TcpOptionUnknown, and ns3::TcpOptionWinScale.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Kind

Constructor & Destructor Documentation

◆ TcpOption()

◆ ~TcpOption()

Member Function Documentation

◆ CreateOption()

◆ Deserialize()

◆ GetInstanceTypeId()

◆ GetKind()

◆ GetSerializedSize()

◆ GetTypeId()

◆ IsKindKnown()

◆ Print()

◆ Serialize()