Defines the TCP option of kind 3 (window scale option) as in RFC 1323 More...
#include "tcp-option-winscale.h"
Public Member Functions | |
TcpOptionWinScale () | |
~TcpOptionWinScale () override | |
uint32_t | Deserialize (Buffer::Iterator start) override |
Deserialize the Option from a buffer iterator. | |
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. | |
uint8_t | GetScale () const |
Get the scale value (uint8_t) | |
uint32_t | GetSerializedSize () const override |
Returns number of bytes required for Option serialization. | |
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 | SetScale (uint8_t scale) |
Set the scale option. | |
Public Member Functions inherited from ns3::TcpOption | |
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. | |
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. | |
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) 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 TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::TcpOption | |
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. | |
Protected Attributes | |
uint8_t | m_scale |
Window scaling in number of bit shift. | |
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. | |
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 Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
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.
ns3::TcpOptionWinScale::TcpOptionWinScale | ( | ) |
Definition at line 32 of file tcp-option-winscale.cc.
|
override |
Definition at line 38 of file tcp-option-winscale.cc.
|
overridevirtual |
Deserialize the Option from a buffer iterator.
start | the buffer iterator |
Implements ns3::TcpOption.
Definition at line 80 of file tcp-option-winscale.cc.
References GetKind(), GetSerializedSize(), m_scale, NS_LOG_WARN, and ns3::Buffer::Iterator::ReadU8().
Referenced by TcpOptionWSTestCase::TestDeserialize().
|
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-winscale.cc.
References GetTypeId().
|
overridevirtual |
Get the ‘kind’ (as in RFC 793) of this option.
Implements ns3::TcpOption.
Definition at line 101 of file tcp-option-winscale.cc.
References ns3::TcpOption::WINSCALE.
Referenced by Deserialize(), and Serialize().
uint8_t ns3::TcpOptionWinScale::GetScale | ( | ) | const |
Get the scale value (uint8_t)
Definition at line 107 of file tcp-option-winscale.cc.
References m_scale, and NS_ASSERT.
Referenced by TcpOptionWSTestCase::TestDeserialize(), and TcpOptionWSTestCase::TestSerialize().
|
overridevirtual |
Returns number of bytes required for Option serialization.
Implements ns3::TcpOption.
Definition at line 65 of file tcp-option-winscale.cc.
Referenced by Deserialize(), and TcpOptionWSTestCase::TestSerialize().
|
static |
Get the type ID.
Definition at line 43 of file tcp-option-winscale.cc.
References ns3::TypeId::SetParent().
Referenced by ns3::TcpOption::CreateOption(), and GetInstanceTypeId().
|
overridevirtual |
Print the Option contents.
os | the output stream |
Implements ns3::TcpOption.
Definition at line 59 of file tcp-option-winscale.cc.
References m_scale.
|
overridevirtual |
Serialize the Option to a buffer iterator.
start | the buffer iterator |
Implements ns3::TcpOption.
Definition at line 71 of file tcp-option-winscale.cc.
References GetKind(), m_scale, and ns3::Buffer::Iterator::WriteU8().
Referenced by TcpOptionWSTestCase::TestSerialize().
void ns3::TcpOptionWinScale::SetScale | ( | uint8_t | scale | ) |
Set the scale option.
The scale option SHOULD be <= 14 (as RFC 1323).
scale | Scale factor |
Definition at line 115 of file tcp-option-winscale.cc.
References m_scale, and NS_ASSERT.
Referenced by TcpOptionWSTestCase::TestSerialize().
|
protected |
Window scaling in number of bit shift.
Definition at line 86 of file tcp-option-winscale.h.
Referenced by Deserialize(), GetScale(), Print(), Serialize(), and SetScale().