This class is designed to probe an underlying ns3 TraceSource exporting a packet, an IPv4 object, and an interface. More...
#include <ipv4-packet-probe.h>
Public Member Functions | |
Ipv4PacketProbe () | |
virtual | ~Ipv4PacketProbe () |
virtual bool | ConnectByObject (std::string traceSource, Ptr< Object > obj) |
connect to a trace source attribute provided by a given object More... | |
virtual void | ConnectByPath (std::string path) |
connect to a trace source provided by a config path More... | |
void | SetValue (Ptr< const Packet > packet, Ptr< Ipv4 > ipv4, uint32_t interface) |
Set a probe value. More... | |
Public Member Functions inherited from ns3::Probe | |
Probe () | |
virtual | ~Probe () |
virtual bool | IsEnabled (void) const |
Public Member Functions inherited from ns3::DataCollectionObject | |
DataCollectionObject () | |
virtual | ~DataCollectionObject () |
void | Disable (void) |
Unset the status of an individual object. More... | |
void | Enable (void) |
Set the status of an individual object. More... | |
std::string | GetName (void) const |
Get the object's name. More... | |
void | SetName (std::string name) |
Set the object's name. All spaces are replaced by underscores. More... | |
Public Member Functions inherited from ns3::Object | |
Object () | |
virtual | ~Object () |
void | AggregateObject (Ptr< Object > other) |
void | Dispose (void) |
Run the DoDispose methods of this object and all the objects aggregated to it. More... | |
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) |
This method calls the virtual DoInitialize method on all the objects aggregated to this object. More... | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Constructor. More... | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. More... | |
uint32_t | GetReferenceCount (void) const |
Get the reference count of the object. More... | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment. 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 |
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 () |
Get the type ID. More... | |
static void | SetValueByPath (std::string path, Ptr< const Packet > packet, Ptr< Ipv4 > ipv4, uint32_t interface) |
Set a probe value by its name in the Config system. More... | |
Static Public Member Functions inherited from ns3::Probe | |
static TypeId | GetTypeId () |
Get the type ID. More... | |
Static Public Member Functions inherited from ns3::DataCollectionObject | |
static TypeId | GetTypeId () |
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::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
static void | Cleanup (void) |
Noop. More... | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Private Member Functions | |
void | TraceSink (Ptr< const Packet > packet, Ptr< Ipv4 > ipv4, uint32_t interface) |
Method to connect to an underlying ns3::TraceSource with arguments of type Ptr<const Packet>, Ptr<Ipv4>, and uint32_t. More... | |
Private Attributes | |
uint32_t | m_interface |
The IPv4 interface for the traced packet. More... | |
Ptr< Ipv4 > | m_ipv4 |
The IPv4 object for the traced packet. More... | |
TracedCallback< Ptr< const Packet >, Ptr< Ipv4 > , uint32_t > | m_output |
Traced Callback: the packet, the Ipv4 object and the interface. More... | |
TracedCallback< uint32_t, uint32_t > | m_outputBytes |
Traced Callback: the previous packet's size and the actual packet's size. More... | |
Ptr< const Packet > | m_packet |
The traced packet. More... | |
uint32_t | m_packetSizeOld |
The size of the traced packet. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
virtual void | DoDispose (void) |
This method is called by Object::Dispose or by the object's destructor, whichever comes first. More... | |
virtual void | DoInitialize (void) |
This method is called only once by Object::Initialize. More... | |
virtual void | NotifyNewAggregate (void) |
This method is invoked whenever two sets of objects are aggregated together. More... | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
virtual void | NotifyConstructionCompleted (void) |
This method is invoked once all member attributes have been initialized. More... | |
Protected Attributes inherited from ns3::Probe | |
Time | m_start |
Time when logging starts. More... | |
Time | m_stop |
Time when logging stops. More... | |
Protected Attributes inherited from ns3::DataCollectionObject | |
bool | m_enabled |
Object's activation state. More... | |
std::string | m_name |
Name of the object within the data collection framework. More... | |
This class is designed to probe an underlying ns3 TraceSource exporting a packet, an IPv4 object, and an interface.
Doxygen introspection did not find any typical Config paths.
This probe exports a trace source "Output" with arguments of type Ptr<const Packet>, Ptr<Ipv4>, and uint32_t. The Output trace source emits a value when either the trace source emits a new value, or when SetValue () is called.
No Attributes are defined for this type.
Definition at line 47 of file ipv4-packet-probe.h.
ns3::Ipv4PacketProbe::Ipv4PacketProbe | ( | ) |
Definition at line 54 of file ipv4-packet-probe.cc.
References m_interface, m_ipv4, m_packet, m_packetSizeOld, and NS_LOG_FUNCTION.
|
virtual |
Definition at line 63 of file ipv4-packet-probe.cc.
References NS_LOG_FUNCTION.
connect to a trace source attribute provided by a given object
traceSource | the name of the attribute TraceSource to connect to |
obj | ns3::Object to connect to |
Implements ns3::Probe.
Definition at line 92 of file ipv4-packet-probe.cc.
References ns3::Names::FindPath(), ns3::MakeCallback(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::ObjectBase::TraceConnectWithoutContext(), and TraceSink().
|
virtual |
connect to a trace source provided by a config path
path | Config path to bind to |
Note, if an invalid path is provided, the probe will not be connected to anything.
Implements ns3::Probe.
Definition at line 101 of file ipv4-packet-probe.cc.
References ns3::Config::ConnectWithoutContext(), ns3::MakeCallback(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and TraceSink().
|
static |
Get the type ID.
Definition at line 39 of file ipv4-packet-probe.cc.
References m_output, m_outputBytes, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().
void ns3::Ipv4PacketProbe::SetValue | ( | Ptr< const Packet > | packet, |
Ptr< Ipv4 > | ipv4, | ||
uint32_t | interface | ||
) |
Set a probe value.
packet | set the traced packet equal to this |
ipv4 | set the IPv4 object for the traced packet equal to this |
interface | set the IPv4 interface for the traced packet equal to this |
Definition at line 69 of file ipv4-packet-probe.cc.
References ns3::Packet::GetSize(), m_interface, m_ipv4, m_output, m_outputBytes, m_packet, m_packetSizeOld, and NS_LOG_FUNCTION.
|
static |
Set a probe value by its name in the Config system.
path | config path to access the probe |
packet | set the traced packet equal to this |
ipv4 | set the IPv4 object for the traced packet equal to this |
interface | set the IPv4 interface for the traced packet equal to this |
Definition at line 83 of file ipv4-packet-probe.cc.
References NS_ASSERT_MSG, and NS_LOG_FUNCTION.
|
private |
Method to connect to an underlying ns3::TraceSource with arguments of type Ptr<const Packet>, Ptr<Ipv4>, and uint32_t.
packet | the traced packet |
ipv4 | the IPv4 object for the traced packet |
interface | the IPv4 interface for the traced packet |
Definition at line 109 of file ipv4-packet-probe.cc.
References ns3::Packet::GetSize(), ns3::Probe::IsEnabled(), m_interface, m_ipv4, m_output, m_outputBytes, m_packet, m_packetSizeOld, and NS_LOG_FUNCTION.
Referenced by ConnectByObject(), and ConnectByPath().
|
private |
The IPv4 interface for the traced packet.
Definition at line 121 of file ipv4-packet-probe.h.
Referenced by Ipv4PacketProbe(), SetValue(), and TraceSink().
The IPv4 object for the traced packet.
Definition at line 118 of file ipv4-packet-probe.h.
Referenced by Ipv4PacketProbe(), SetValue(), and TraceSink().
|
private |
Traced Callback: the packet, the Ipv4 object and the interface.
Definition at line 110 of file ipv4-packet-probe.h.
Referenced by GetTypeId(), SetValue(), and TraceSink().
|
private |
Traced Callback: the previous packet's size and the actual packet's size.
Definition at line 112 of file ipv4-packet-probe.h.
Referenced by GetTypeId(), SetValue(), and TraceSink().
The traced packet.
Definition at line 115 of file ipv4-packet-probe.h.
Referenced by Ipv4PacketProbe(), SetValue(), and TraceSink().
|
private |
The size of the traced packet.
Definition at line 124 of file ipv4-packet-probe.h.
Referenced by Ipv4PacketProbe(), SetValue(), and TraceSink().