Base class for all kinds of TCP options. More...
#include "tcp-option.h"
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. | |
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 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 Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
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.
Size of this type is 32 bytes (on a 64-bit architecture).
Definition at line 37 of file tcp-option.h.
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 54 of file tcp-option.h.
ns3::TcpOption::TcpOption | ( | ) |
Definition at line 40 of file tcp-option.cc.
|
override |
Definition at line 44 of file tcp-option.cc.
Creates an option.
kind | the option kind |
Definition at line 62 of file tcp-option.cc.
References ns3::ObjectFactory::Create(), END, ns3::TcpOptionEnd::GetTypeId(), ns3::TcpOptionNOP::GetTypeId(), ns3::TcpOptionMSS::GetTypeId(), ns3::TcpOptionSackPermitted::GetTypeId(), ns3::TcpOptionSack::GetTypeId(), ns3::TcpOptionTS::GetTypeId(), ns3::TcpOptionWinScale::GetTypeId(), ns3::TcpOptionUnknown::GetTypeId(), MSS, NOP, SACK, SACKPERMITTED, ns3::ObjectFactory::SetTypeId(), TS, UNKNOWN, and WINSCALE.
Referenced by ns3::TcpHeader::Deserialize().
|
pure virtual |
Deserialize the Option from a buffer iterator.
start | the buffer iterator |
Implemented in ns3::TcpOptionEnd, ns3::TcpOptionNOP, ns3::TcpOptionMSS, ns3::TcpOptionSackPermitted, ns3::TcpOptionSack, ns3::TcpOptionTS, ns3::TcpOptionWinScale, and ns3::TcpOptionUnknown.
|
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.
Reimplemented in ns3::TcpOptionUnknown.
Definition at line 56 of file tcp-option.cc.
References GetTypeId().
|
pure virtual |
Get the ‘kind’ (as in RFC 793) of this option.
Implemented in ns3::TcpOptionEnd, ns3::TcpOptionNOP, ns3::TcpOptionMSS, ns3::TcpOptionSackPermitted, ns3::TcpOptionSack, ns3::TcpOptionTS, ns3::TcpOptionWinScale, and ns3::TcpOptionUnknown.
|
pure virtual |
Returns number of bytes required for Option serialization.
Implemented in ns3::TcpOptionEnd, ns3::TcpOptionNOP, ns3::TcpOptionMSS, ns3::TcpOptionSackPermitted, ns3::TcpOptionSack, ns3::TcpOptionTS, ns3::TcpOptionWinScale, and ns3::TcpOptionUnknown.
|
static |
Get the type ID.
Definition at line 49 of file tcp-option.cc.
References ns3::TypeId::SetParent().
Referenced by GetInstanceTypeId().
|
static |
Check if the option is implemented.
kind | the Option kind |
Definition at line 95 of file tcp-option.cc.
References END, MSS, NOP, SACK, SACKPERMITTED, TS, and WINSCALE.
Referenced by ns3::TcpHeader::AppendOption(), and ns3::TcpHeader::Deserialize().
|
pure virtual |
Print the Option contents.
os | the output stream |
Implemented in ns3::TcpOptionEnd, ns3::TcpOptionNOP, ns3::TcpOptionMSS, ns3::TcpOptionSackPermitted, ns3::TcpOptionSack, ns3::TcpOptionTS, ns3::TcpOptionWinScale, and ns3::TcpOptionUnknown.
|
pure virtual |
Serialize the Option to a buffer iterator.
start | the buffer iterator |
Implemented in ns3::TcpOptionEnd, ns3::TcpOptionNOP, ns3::TcpOptionMSS, ns3::TcpOptionSackPermitted, ns3::TcpOptionSack, ns3::TcpOptionTS, ns3::TcpOptionWinScale, and ns3::TcpOptionUnknown.