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, TS = 8, UNKNOWN = 255 }
	The option Kind, as defined in the respective RFCs. More...

Public Member Functions
	TcpOption ()

virtual	~TcpOption ()

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

virtual TypeId	GetInstanceTypeId (void) const

virtual uint8_t	GetKind (void) const =0
	Get the `kind' (as in RFC 793) of this option. More...

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

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

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

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

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

AggregateIterator	GetAggregateIterator (void) const

template<typename T >
Ptr< T >	GetObject (void) const

template<typename T >
Ptr< T >	GetObject (TypeId tid) const

void	Initialize (void)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. 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

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
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::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...

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

virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Detailed Description

Base class for all kinds of TCP options.

Doxygen introspection did not find any typical Config paths.

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

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

Member Enumeration Documentation

enum ns3::TcpOption::Kind

The option Kind, as defined in the respective RFCs.

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

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

Constructor & Destructor Documentation

ns3::TcpOption::TcpOption ( )

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

ns3::TcpOption::~TcpOption ( )

virtual

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

Member Function Documentation

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 62 of file tcp-option.cc.

References ns3::ObjectFactory::Create(), END, ns3::TcpOptionEnd::GetTypeId(), ns3::TcpOptionTS::GetTypeId(), ns3::TcpOptionWinScale::GetTypeId(), ns3::TcpOptionNOP::GetTypeId(), ns3::TcpOptionMSS::GetTypeId(), ns3::TcpOptionUnknown::GetTypeId(), MSS, NOP, 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:

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::TcpOptionUnknown, ns3::TcpOptionMSS, ns3::TcpOptionNOP, ns3::TcpOptionWinScale, ns3::TcpOptionTS, and ns3::TcpOptionEnd.

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

Here is the caller graph for this function:

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

virtual

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

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

Reimplemented from ns3::Object.

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

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

References GetTypeId().

Here is the call graph for this function: