A general (TCP-aware) error model. More...

#include "tcp-error-model.h"

Inheritance diagram for ns3::TcpGeneralErrorModel:

Collaboration diagram for ns3::TcpGeneralErrorModel:

Public Member Functions
	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 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.

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::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
virtual bool	ShouldDrop (const Ipv4Header &ipHeader, const TcpHeader &tcpHeader, uint32_t packetSize)=0
	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.

Private Member Functions
bool	DoCorrupt (Ptr< Packet > p) override
	Corrupt a packet according to the specified model.

Private Attributes
Callback< void, const Ipv4Header &, const TcpHeader &, Ptr< const Packet > >	m_dropCallback
	Drop callback.

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

A general (TCP-aware) error model.

The class is responsible to take away the IP and TCP header from the packet, and then to interrogate the method ShouldDrop, dropping the packet accordingly to the returned value.

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

Constructor & Destructor Documentation

◆ TcpGeneralErrorModel()

ns3::TcpGeneralErrorModel::TcpGeneralErrorModel ( )

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoCorrupt()

bool ns3::TcpGeneralErrorModel::DoCorrupt ( Ptr< Packet > p )

overrideprivatevirtual

Corrupt a packet according to the specified model.

Parameters

p	the packet to corrupt

Returns: true if the packet is corrupted

Implements ns3::ErrorModel.

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

References ns3::ErrorModel::IsEnabled(), m_dropCallback, NS_LOG_FUNCTION, and ShouldDrop().

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::TcpGeneralErrorModel::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

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

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ SetDropCallback()

void ns3::TcpGeneralErrorModel::SetDropCallback ( Callback< void, const Ipv4Header &, const TcpHeader &, Ptr< const Packet > > cb )

inline

Set the drop callback.

Parameters

cb	The callback to be set.

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

References m_dropCallback.

◆ ShouldDrop()

virtual bool ns3::TcpGeneralErrorModel::ShouldDrop	(	const Ipv4Header &	ipHeader,
		const TcpHeader &	tcpHeader,
		uint32_t	packetSize )

protectedpure virtual

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.

Implemented in ns3::TcpFlagErrorModel, ns3::TcpSeqErrorModel, and TcpDropRatioErrorModel.

Referenced by DoCorrupt().

Here is the caller graph for this function:

Member Data Documentation

◆ m_dropCallback

Callback<void, const Ipv4Header&, const TcpHeader&, Ptr<const Packet> > ns3::TcpGeneralErrorModel::m_dropCallback

private

Drop callback.

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

Referenced by DoCorrupt(), and SetDropCallback().

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

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TcpGeneralErrorModel()

Member Function Documentation

◆ DoCorrupt()

◆ GetTypeId()

◆ SetDropCallback()

◆ ShouldDrop()

Member Data Documentation

◆ m_dropCallback