A Discrete-Event Network Simulator
API
ns3::TcpSeqErrorModel Class Reference

An error model TCP aware: it drops the sequence number declared. More...

#include "tcp-error-model.h"

+ Inheritance diagram for ns3::TcpSeqErrorModel:
+ Collaboration diagram for ns3::TcpSeqErrorModel:

Public Member Functions

 TcpSeqErrorModel ()
 
void AddSeqToKill (const SequenceNumber32 &seq)
 Add the sequence number to the list of segments to be killed. More...
 
- Public Member Functions inherited from ns3::TcpGeneralErrorModel
 TcpGeneralErrorModel ()
 
void SetDropCallback (Callback< void, const Ipv4Header &, const TcpHeader &, Ptr< const Packet > > cb)
 Set the drop callback. More...
 
- Public Member Functions inherited from ns3::ErrorModel
 ErrorModel ()
 
virtual ~ErrorModel ()
 
void Disable (void)
 Disable the error model. More...
 
void Enable (void)
 Enable the error model. More...
 
bool IsCorrupt (Ptr< Packet > pkt)
 Note: Depending on the error model, this function may or may not alter the contents of the packet upon returning true. More...
 
bool IsEnabled (void) const
 
void Reset (void)
 Reset any state associated with the error model. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default 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 operator. 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
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::TcpGeneralErrorModel
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::ErrorModel
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Protected Member Functions

virtual bool ShouldDrop (const Ipv4Header &ipHeader, const TcpHeader &tcpHeader, uint32_t packetSize)
 Check if the packet should be dropped. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Protected Attributes

std::list< SequenceNumber32m_seqToKill
 List of the sequence numbers to be dropped. More...
 

Private Member Functions

virtual void DoReset (void)
 Re-initialize any state. More...
 

Additional Inherited Members

Detailed Description

An error model TCP aware: it drops the sequence number declared.

See also
AddSeqToKill

Definition at line 82 of file tcp-error-model.h.

Constructor & Destructor Documentation

◆ TcpSeqErrorModel()

ns3::TcpSeqErrorModel::TcpSeqErrorModel ( )
inline

Definition at line 90 of file tcp-error-model.h.

Member Function Documentation

◆ AddSeqToKill()

void ns3::TcpSeqErrorModel::AddSeqToKill ( const SequenceNumber32 seq)
inline

Add the sequence number to the list of segments to be killed.

Calling x times this function indicates that you want to kill the segment x times.

Parameters
seqsequence number to be killed

Definition at line 100 of file tcp-error-model.h.

References m_seqToKill.

Referenced by ns3::TcpCloseWithLossTestCase::CreateReceiverErrorModel(), TcpFastRetrTest::CreateReceiverErrorModel(), TcpBytesInFlightTest::CreateReceiverErrorModel(), TcpSsThreshRtoTest::CreateReceiverErrorModel(), TcpRttEstimationWithLossTest::CreateReceiverErrorModel(), TcpRateLinuxWithSocketsTest::CreateReceiverErrorModel(), TcpTimeRtoTest::CreateReceiverErrorModel(), and TcpAdvWindowOnLossTest::CreateReceiverErrorModel().

+ Here is the caller graph for this function:

◆ DoReset()

void ns3::TcpSeqErrorModel::DoReset ( void  )
privatevirtual

Re-initialize any state.

Implements ns3::ErrorModel.

Definition at line 109 of file tcp-error-model.cc.

References m_seqToKill.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 75 of file tcp-error-model.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ ShouldDrop()

bool ns3::TcpSeqErrorModel::ShouldDrop ( const Ipv4Header ipHeader,
const TcpHeader tcpHeader,
uint32_t  packetSize 
)
protectedvirtual

Check if the packet should be dropped.

Parameters
ipHeaderThe packet IPv4 header.
tcpHeaderThe packet TCP header.
packetSizeThe packet size.
Returns
True if the packet should be dropped.

Implements ns3::TcpGeneralErrorModel.

Definition at line 85 of file tcp-error-model.cc.

References ns3::TcpHeader::GetSequenceNumber(), m_seqToKill, NS_LOG_FUNCTION, NS_LOG_INFO, and packetSize.

+ Here is the call graph for this function:

Member Data Documentation

◆ m_seqToKill

std::list<SequenceNumber32> ns3::TcpSeqErrorModel::m_seqToKill
protected

List of the sequence numbers to be dropped.

Definition at line 110 of file tcp-error-model.h.

Referenced by AddSeqToKill(), DoReset(), and ShouldDrop().


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