Defines the TCP option of kind 8 (timestamp option) as in RFC 1323 More...
#include "tcp-option-ts.h"
Public Member Functions | |
TcpOptionTS () | |
~TcpOptionTS () override | |
uint32_t | Deserialize (Buffer::Iterator start) override |
Deserialize the Option from a buffer iterator. | |
uint32_t | GetEcho () const |
Get the timestamp echo stored in the Option. | |
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 | GetSerializedSize () const override |
Returns number of bytes required for Option serialization. | |
uint32_t | GetTimestamp () const |
Get the timestamp stored in the Option. | |
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. | |
void | SetEcho (uint32_t ts) |
Set the timestamp echo stored in the Option. | |
void | SetTimestamp (uint32_t ts) |
Set the timestamp stored in the Option. | |
![]() | |
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. | |
![]() | |
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. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
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. | |
![]() | |
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. | |
![]() | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value) 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. | |
virtual TypeId | GetInstanceTypeId () const =0 |
Get the most derived TypeId for this Object. | |
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 Time | ElapsedTimeFromTsValue (uint32_t echoTime) |
Estimate the Time elapsed from a TS echo value. | |
static TypeId | GetTypeId () |
Get the type ID. | |
static uint32_t | NowToTsValue () |
Return an uint32_t value which represent "now". | |
![]() | |
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 TypeId | GetTypeId () |
Register this type. | |
![]() | |
static TypeId | GetTypeId () |
Get the type ID. | |
Protected Attributes | |
uint32_t | m_echo |
echo timestamp | |
uint32_t | m_timestamp |
local timestamp | |
Additional Inherited Members | |
![]() | |
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... | |
![]() | |
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. | |
![]() | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
![]() | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Defines the TCP option of kind 8 (timestamp option) as in RFC 1323
Introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 40 bytes (on a 64-bit architecture).
Definition at line 35 of file tcp-option-ts.h.
ns3::TcpOptionTS::TcpOptionTS | ( | ) |
Definition at line 31 of file tcp-option-ts.cc.
|
override |
Definition at line 38 of file tcp-option-ts.cc.
|
overridevirtual |
Deserialize the Option from a buffer iterator.
start | the buffer iterator |
Implements ns3::TcpOption.
Definition at line 81 of file tcp-option-ts.cc.
References GetKind(), GetSerializedSize(), m_echo, m_timestamp, NS_LOG_WARN, ns3::Buffer::Iterator::ReadNtohU32(), and ns3::Buffer::Iterator::ReadU8().
Referenced by TcpOptionTSTestCase::TestDeserialize().
Estimate the Time elapsed from a TS echo value.
The echoTime should be a value returned from NowToTsValue.
echoTime | Echoed value from other side |
Definition at line 144 of file tcp-option-ts.cc.
References ns3::Time::GetMilliSeconds(), ns3::MilliSeconds(), ns3::Simulator::Now(), and ns3::Seconds().
Referenced by TimestampValueTestCase::Check(), and ns3::TcpSocketBase::EstimateRtt().
uint32_t ns3::TcpOptionTS::GetEcho | ( | ) | const |
Get the timestamp echo stored in the Option.
Definition at line 116 of file tcp-option-ts.cc.
References m_echo.
Referenced by TcpOptionTSTestCase::TestDeserialize(), and TcpOptionTSTestCase::TestSerialize().
|
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.
Reimplemented from ns3::Object.
Definition at line 53 of file tcp-option-ts.cc.
References GetTypeId().
|
overridevirtual |
Get the ‘kind’ (as in RFC 793) of this option.
Implements ns3::TcpOption.
Definition at line 104 of file tcp-option-ts.cc.
References ns3::TcpOption::TS.
Referenced by Deserialize(), and Serialize().
|
overridevirtual |
Returns number of bytes required for Option serialization.
Implements ns3::TcpOption.
Definition at line 65 of file tcp-option-ts.cc.
Referenced by Deserialize(), and TcpOptionTSTestCase::TestSerialize().
uint32_t ns3::TcpOptionTS::GetTimestamp | ( | ) | const |
Get the timestamp stored in the Option.
Definition at line 110 of file tcp-option-ts.cc.
References m_timestamp.
Referenced by TcpOptionTSTestCase::TestDeserialize(), and TcpOptionTSTestCase::TestSerialize().
|
static |
Get the type ID.
Definition at line 43 of file tcp-option-ts.cc.
References ns3::TypeId::SetParent().
Referenced by ns3::TcpOption::CreateOption(), and GetInstanceTypeId().
|
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.
Definition at line 134 of file tcp-option-ts.cc.
References ns3::Time::GetMilliSeconds(), and ns3::Simulator::Now().
Referenced by ns3::TcpSocketBase::AddOptionTimestamp(), TimestampValueTestCase::Check(), and TimestampValueTestCase::Init().
|
overridevirtual |
Print the Option contents.
os | the output stream |
Implements ns3::TcpOption.
Definition at line 59 of file tcp-option-ts.cc.
References m_echo, and m_timestamp.
|
overridevirtual |
Serialize the Option to a buffer iterator.
start | the buffer iterator |
Implements ns3::TcpOption.
Definition at line 71 of file tcp-option-ts.cc.
References GetKind(), m_echo, m_timestamp, ns3::Buffer::Iterator::WriteHtonU32(), and ns3::Buffer::Iterator::WriteU8().
Referenced by TcpOptionTSTestCase::TestSerialize().
void ns3::TcpOptionTS::SetEcho | ( | uint32_t | ts | ) |
Set the timestamp echo stored in the Option.
ts | the timestamp echo |
Definition at line 128 of file tcp-option-ts.cc.
References m_echo.
Referenced by TcpOptionTSTestCase::TestSerialize().
void ns3::TcpOptionTS::SetTimestamp | ( | uint32_t | ts | ) |
Set the timestamp stored in the Option.
ts | the timestamp |
Definition at line 122 of file tcp-option-ts.cc.
References m_timestamp.
Referenced by TcpOptionTSTestCase::TestSerialize().
|
protected |
echo timestamp
Definition at line 105 of file tcp-option-ts.h.
Referenced by Deserialize(), GetEcho(), Print(), Serialize(), and SetEcho().
|
protected |
local timestamp
Definition at line 104 of file tcp-option-ts.h.
Referenced by Deserialize(), GetTimestamp(), Print(), Serialize(), and SetTimestamp().