Defines the TCP option of kind 8 (timestamp option) as in RFC 1323 More...

#include <tcp-option-ts.h>

Inheritance diagram for ns3::TcpOptionTS:

Collaboration diagram for ns3::TcpOptionTS:

Public Member Functions
	TcpOptionTS ()

virtual	~TcpOptionTS ()

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

uint32_t	GetEcho (void) const
	Get the timestamp echo stored in the Option. More...

virtual TypeId	GetInstanceTypeId (void) const

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

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

uint32_t	GetTimestamp (void) const
	Get the timestamp stored in the Option. 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	SetEcho (uint32_t ts)
	Set the timestamp echo stored in the Option. More...

void	SetTimestamp (uint32_t ts)
	Set the timestamp stored in the Option. More...

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

virtual	~TcpOption ()

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 Time	ElapsedTimeFromTsValue (uint32_t echoTime)
	Estimate the Time elapsed from a TS echo value. More...

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

static uint32_t	NowToTsValue ()
	Return an uint32_t value which represent "now". 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::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...

Protected Attributes
uint32_t	m_echo
	echo timestamp More...

uint32_t	m_timestamp
	local timestamp More...

Additional Inherited Members
Public Types inherited from ns3::TcpOption
enum	Kind { END = 0, NOP = 1, MSS = 2, WINSCALE = 3, 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)

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

Defines the TCP option of kind 8 (timestamp option) as in RFC 1323

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 33 of file tcp-option-ts.h.

Constructor & Destructor Documentation

ns3::TcpOptionTS::TcpOptionTS ( )

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

ns3::TcpOptionTS::~TcpOptionTS ( )

virtual

Definition at line 36 of file tcp-option-ts.cc.

Member Function Documentation

uint32_t ns3::TcpOptionTS::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 79 of file tcp-option-ts.cc.

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

Referenced by ns3::TcpOptionTSTestCase::TestDeserialize().

Here is the call graph for this function:

Here is the caller graph for this function:

Time ns3::TcpOptionTS::ElapsedTimeFromTsValue ( uint32_t echoTime )

static

Estimate the Time elapsed from a TS echo value.

The echoTime should be a value returned from NowToTsValue.

Parameters

echoTime Echoed value from other side

See also: NowToTsValue

Returns: The measured RTT

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

References ns3::Time::GetMilliSeconds(), ns3::MilliSeconds(), ns3::Simulator::Now(), and ns3::Seconds().

Referenced by ns3::TimestampValueTestCase::Check(), and ns3::TcpSocketBase::EstimateRtt().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::TcpOptionTS::GetEcho ( void ) const

Get the timestamp echo stored in the Option.

Returns: the timestamp echo

Definition at line 114 of file tcp-option-ts.cc.

References m_echo.

Referenced by ns3::TcpOptionTSTestCase::TestDeserialize(), and ns3::TcpOptionTSTestCase::TestSerialize().

Here is the caller graph for this function:

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

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

References GetTypeId().

Here is the call graph for this function:

uint8_t ns3::TcpOptionTS::GetKind ( void ) const

virtual

Get the `kind' (as in RFC 793) of this option.

Returns: the Option Kind

Implements ns3::TcpOption.

Definition at line 102 of file tcp-option-ts.cc.

References ns3::TcpOption::TS.

Referenced by Deserialize(), and Serialize().

Here is the caller graph for this function:

uint32_t ns3::TcpOptionTS::GetSerializedSize ( void ) const

virtual

Returns number of bytes required for Option serialization.

Returns: number of bytes required for Option serialization

Implements ns3::TcpOption.

Definition at line 63 of file tcp-option-ts.cc.

Referenced by Deserialize(), and ns3::TcpOptionTSTestCase::TestSerialize().

Here is the caller graph for this function:

uint32_t ns3::TcpOptionTS::GetTimestamp ( void ) const

Get the timestamp stored in the Option.

Returns: the timestamp

Definition at line 108 of file tcp-option-ts.cc.

References m_timestamp.

Referenced by ns3::TcpOptionTSTestCase::TestDeserialize(), and ns3::TcpOptionTSTestCase::TestSerialize().

Here is the caller graph for this function:

TypeId ns3::TcpOptionTS::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 41 of file tcp-option-ts.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:

uint32_t ns3::TcpOptionTS::NowToTsValue ( )

static

Return an uint32_t value which represent "now".

The value returned is usually used as Timestamp option for the TCP header; when the value will be echoed back, calculating the RTT will be an easy matter.

The RFC does not mention any units for this value; following what is implemented in OS, we use milliseconds. Any change to this must be reflected to EstimateRttFromTs.