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.

Public Member Functions inherited from ns3::TcpGeneralErrorModel
	TcpGeneralErrorModel ()

void	SetDropCallback (Callback< void, const Ipv4Header &, const TcpHeader &, Ptr< const Packet > > cb)
	Set the drop callback.

Public Member Functions inherited from ns3::ErrorModel
	ErrorModel ()

	~ErrorModel () override

void	Disable ()
	Disable the error model.

void	Enable ()
	Enable the error model.

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.

bool	IsEnabled () const

void	Reset ()
	Reset any state associated with the error model.

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 final
	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.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

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, bool permissive=false) 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.

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::TcpGeneralErrorModel
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::ErrorModel
static TypeId	GetTypeId ()
	Get the type ID.

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 Member Functions
bool	ShouldDrop (const Ipv4Header &ipHeader, const TcpHeader &tcpHeader, uint32_t packetSize) override
	Check if the packet should be dropped.

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.

Protected Attributes
std::list< SequenceNumber32 >	m_seqToKill
	List of the sequence numbers to be dropped.

Private Member Functions
void	DoReset () override
	Re-initialize any state.

Additional Inherited Members
Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

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

See also: AddSeqToKill

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

Constructor & Destructor Documentation

◆ TcpSeqErrorModel()

ns3::TcpSeqErrorModel::TcpSeqErrorModel ( )

inline

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

References ns3::TcpGeneralErrorModel::TcpGeneralErrorModel().

Here is the call graph for this function:

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

seq	sequence number to be killed

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

References m_seqToKill.

◆ DoReset()

void ns3::TcpSeqErrorModel::DoReset ( )

overrideprivatevirtual

Re-initialize any state.

Implements ns3::ErrorModel.

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

References m_seqToKill.

◆ GetTypeId()

TypeId ns3::TcpSeqErrorModel::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

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

References ns3::TcpGeneralErrorModel::TcpGeneralErrorModel(), and 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 )

overrideprotectedvirtual

Check if the packet should be dropped.

Parameters

ipHeader	The packet IPv4 header.
tcpHeader	The packet TCP header.
packetSize	The packet size.

Returns: True if the packet should be dropped.

Implements ns3::TcpGeneralErrorModel.

Definition at line 73 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 103 of file tcp-error-model.h.

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

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

src/internet/test/tcp-error-model.h
src/internet/test/tcp-error-model.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TcpSeqErrorModel()

Member Function Documentation

◆ AddSeqToKill()

◆ DoReset()

◆ GetTypeId()

◆ ShouldDrop()

Member Data Documentation

◆ m_seqToKill