A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::TcpOptionMSS Class Reference

Defines the TCP option of kind 2 (maximum segment size) as in RFC 793 More...

#include <tcp-option-rfc793.h>

+ Inheritance diagram for ns3::TcpOptionMSS:
+ Collaboration diagram for ns3::TcpOptionMSS:

Public Member Functions

 TcpOptionMSS ()
 
virtual ~TcpOptionMSS ()
 
virtual uint32_t Deserialize (Buffer::Iterator start)
 Deserialize the Option from a buffer iterator. More...
 
virtual TypeId GetInstanceTypeId (void) const
 
virtual uint8_t GetKind (void) const
 Get the `kind' (as in RFC 793) of this option. More...
 
uint16_t GetMSS (void) const
 Get the Maximum Segment Size stored in the Option. More...
 
virtual uint32_t GetSerializedSize (void) const
 Returns number of bytes required for Option serialization. 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 SetMSS (uint16_t mss)
 Set the Maximum Segment Size 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...
 
SimpleRefCountoperator= (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 TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::TcpOption
static Ptr< TcpOptionCreateOption (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

uint16_t m_mss
 maximum segment size 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 2 (maximum segment size) as in RFC 793

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 79 of file tcp-option-rfc793.h.

Constructor & Destructor Documentation

ns3::TcpOptionMSS::TcpOptionMSS ( )

Definition at line 172 of file tcp-option-rfc793.cc.

ns3::TcpOptionMSS::~TcpOptionMSS ( )
virtual

Definition at line 178 of file tcp-option-rfc793.cc.

Member Function Documentation

uint32_t ns3::TcpOptionMSS::Deserialize ( Buffer::Iterator  start)
virtual

Deserialize the Option from a buffer iterator.

Parameters
startthe buffer iterator
Returns
the number of deserialized bytes

Implements ns3::TcpOption.

Definition at line 220 of file tcp-option-rfc793.cc.

References GetKind(), GetSerializedSize(), m_mss, NS_ASSERT, NS_LOG_WARN, ns3::Buffer::Iterator::ReadNtohU16(), ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

+ Here is the call graph for this function:

TypeId ns3::TcpOptionMSS::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 193 of file tcp-option-rfc793.cc.

References GetTypeId().

+ Here is the call graph for this function:

uint8_t ns3::TcpOptionMSS::GetKind ( void  ) const
virtual

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

Returns
the Option Kind

Implements ns3::TcpOption.

Definition at line 240 of file tcp-option-rfc793.cc.

References ns3::TcpOption::MSS.

Referenced by Deserialize(), and Serialize().

+ Here is the caller graph for this function:

uint16_t ns3::TcpOptionMSS::GetMSS ( void  ) const

Get the Maximum Segment Size stored in the Option.

Returns
The Maximum Segment Size

Definition at line 246 of file tcp-option-rfc793.cc.

References m_mss.

uint32_t ns3::TcpOptionMSS::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 205 of file tcp-option-rfc793.cc.

Referenced by Deserialize().

+ Here is the caller graph for this function:

TypeId ns3::TcpOptionMSS::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

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

void ns3::TcpOptionMSS::Print ( std::ostream &  os) const
virtual

Print the Option contents.

Parameters
osthe output stream

Implements ns3::TcpOption.

Definition at line 199 of file tcp-option-rfc793.cc.

References m_mss.

void ns3::TcpOptionMSS::Serialize ( Buffer::Iterator  start) const
virtual

Serialize the Option to a buffer iterator.

Parameters
startthe buffer iterator

Implements ns3::TcpOption.

Definition at line 211 of file tcp-option-rfc793.cc.

References GetKind(), m_mss, visualizer.core::start(), ns3::Buffer::Iterator::WriteHtonU16(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

void ns3::TcpOptionMSS::SetMSS ( uint16_t  mss)

Set the Maximum Segment Size stored in the Option.

Parameters
mssThe Maximum Segment Size

Definition at line 252 of file tcp-option-rfc793.cc.

References m_mss.

Referenced by ns3::TcpHeaderWithRFC793OptionTestCase::OneOptionAtTime().

+ Here is the caller graph for this function:

Member Data Documentation

uint16_t ns3::TcpOptionMSS::m_mss
protected

maximum segment size

Definition at line 111 of file tcp-option-rfc793.h.

Referenced by Deserialize(), GetMSS(), Print(), Serialize(), and SetMSS().


The documentation for this class was generated from the following files: