General error model that can be used to corrupt packets. More...
#include <error-model.h>
Public Member Functions | |
void | Disable (void) |
void | Enable (void) |
bool | IsCorrupt (Ptr< Packet > pkt) |
bool | IsEnabled (void) const |
void | Reset (void) |
Public Member Functions inherited from ns3::Object | |
void | AggregateObject (Ptr< Object > other) |
void | Dispose (void) |
AggregateIterator | GetAggregateIterator (void) const |
virtual TypeId | GetInstanceTypeId (void) const |
template<typename T > | |
Ptr< T > | GetObject (void) const |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
void | Initialize (void) |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount (const SimpleRefCount &o) | |
uint32_t | GetReferenceCount (void) const |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
void | Ref (void) const |
void | Unref (void) const |
Public Member Functions inherited from ns3::ObjectBase | |
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) |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId (void) |
Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
static void | Cleanup (void) |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId (void) |
Private Member Functions | |
virtual bool | DoCorrupt (Ptr< Packet >)=0 |
virtual void | DoReset (void)=0 |
Private Attributes | |
bool | m_enable |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
virtual void | DoDispose (void) |
virtual void | DoInitialize (void) |
virtual void | NotifyNewAggregate (void) |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
virtual void | NotifyConstructionCompleted (void) |
General error model that can be used to corrupt packets.
This object is used to flag packets as being lost/errored or not. It is part of the Object framework and can be aggregated to other ns3 objects and handled by the Ptr class.
The main method is IsCorrupt(Ptr<Packet> p) which returns true if the packet is to be corrupted according to the underlying model. Depending on the error model, the packet itself may have its packet data buffer errored or not, or side information may be returned to the client in the form of a packet tag. (Note: No such error models that actually error the bits in a packet presently exist). The object can have state (resettable by Reset()). The object can also be enabled and disabled via two public member functions.
Typical code (simplified) to use an ErrorModel may look something like this:
Four practical error models, a RateErrorModel, a BurstErrorModel, a ListErrorModel, and a ReceiveListErrorModel, are currently implemented.
ns3::ErrorModel is accessible through the following paths with Config::Set and Config::Connect:
No TraceSources are defined for this type.
Definition at line 115 of file error-model.h.
void ns3::ErrorModel::Disable | ( | void | ) |
Disable the error model
Definition at line 131 of file error-model.cc.
References NS_LOG_FUNCTION.
Referenced by Ipv4FragmentationTest::DoRun(), and Ipv6FragmentationTest::DoRun().
void ns3::ErrorModel::Enable | ( | void | ) |
Enable the error model
Definition at line 124 of file error-model.cc.
References NS_LOG_FUNCTION.
Referenced by Ipv4FragmentationTest::DoRun(), and Ipv6FragmentationTest::DoRun().
Note: Depending on the error model, this function may or may not alter the contents of the packet upon returning true.
pkt | Packet to apply error model to |
Definition at line 106 of file error-model.cc.
References NS_LOG_FUNCTION.
bool ns3::ErrorModel::IsEnabled | ( | void | ) | const |
Definition at line 138 of file error-model.cc.
References NS_LOG_FUNCTION.
void ns3::ErrorModel::Reset | ( | void | ) |
Reset any state associated with the error model
Definition at line 117 of file error-model.cc.
References NS_LOG_FUNCTION.