A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
TcpDropRatioErrorModel Class Reference

An error model that randomly drops a given rátio of TCP segments. More...

+ Inheritance diagram for TcpDropRatioErrorModel:
+ Collaboration diagram for TcpDropRatioErrorModel:

Public Member Functions

 TcpDropRatioErrorModel (double dropRatio)
 Constructor.
 
- 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 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< ObjectGetObject () 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< ObjectGetObject (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.
 
SimpleRefCountoperator= (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.
 

Private Member Functions

void DoReset () override
 Re-initialize any state.
 

Private Attributes

double m_dropRatio
 Drop ratio.
 
Ptr< UniformRandomVariablem_prng
 Random variable.
 

Additional Inherited Members

Detailed Description

An error model that randomly drops a given rátio of TCP segments.

Definition at line 203 of file tcp-advertised-window-test.cc.

Constructor & Destructor Documentation

◆ TcpDropRatioErrorModel()

TcpDropRatioErrorModel::TcpDropRatioErrorModel ( double dropRatio)
inline

Constructor.

Parameters
dropRatiothe drop ratio

Definition at line 216 of file tcp-advertised-window-test.cc.

References ns3::CreateObject(), and m_prng.

+ Here is the call graph for this function:

Member Function Documentation

◆ DoReset()

void TcpDropRatioErrorModel::DoReset ( )
inlineoverrideprivatevirtual

Re-initialize any state.

Implements ns3::ErrorModel.

Definition at line 229 of file tcp-advertised-window-test.cc.

◆ GetTypeId()

TypeId TcpDropRatioErrorModel::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 240 of file tcp-advertised-window-test.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ ShouldDrop()

bool TcpDropRatioErrorModel::ShouldDrop ( const Ipv4Header & ipHeader,
const TcpHeader & tcpHeader,
uint32_t packetSize )
overrideprotectedvirtual

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 247 of file tcp-advertised-window-test.cc.

References m_dropRatio, and m_prng.

Member Data Documentation

◆ m_dropRatio

double TcpDropRatioErrorModel::m_dropRatio
private

Drop ratio.

Definition at line 233 of file tcp-advertised-window-test.cc.

Referenced by ShouldDrop().

◆ m_prng

Ptr<UniformRandomVariable> TcpDropRatioErrorModel::m_prng
private

Random variable.

Definition at line 234 of file tcp-advertised-window-test.cc.

Referenced by TcpDropRatioErrorModel(), and ShouldDrop().


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