Probe to translate from a TraceSource to two more easily parsed TraceSources. More...
#include "application-packet-probe.h"
 Inheritance diagram for ns3::ApplicationPacketProbe:
 Inheritance diagram for ns3::ApplicationPacketProbe: Collaboration diagram for ns3::ApplicationPacketProbe:
 Collaboration diagram for ns3::ApplicationPacketProbe:| Public Member Functions | |
| ApplicationPacketProbe () | |
| virtual | ~ApplicationPacketProbe () | 
| 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, const Address &address) | 
| 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 () | |
| Constructor.  More... | |
| virtual | ~Object () | 
| Destructor.  More... | |
| void | AggregateObject (Ptr< Object > other) | 
| Aggregate two Objects together.  More... | |
| void | Dispose (void) | 
| Dispose of this Object.  More... | |
| AggregateIterator | GetAggregateIterator (void) const | 
| Get an iterator to the Objects aggregated to this one.  More... | |
| virtual TypeId | GetInstanceTypeId (void) const | 
| Get the most derived TypeId for this Object.  More... | |
| template<typename T > | |
| Ptr< T > | GetObject (void) const | 
| Get a pointer to the requested aggregated Object.  More... | |
| template<typename T > | |
| Ptr< T > | GetObject (TypeId tid) const | 
| Get a pointer to the requested aggregated Object by TypeId.  More... | |
| template<> | |
| Ptr< Object > | GetObject () const | 
| Specialization of ()  for objects of type ns3::Object.  More... | |
| template<> | |
| Ptr< Object > | GetObject (TypeId tid) const | 
| Specialization of (TypeId tid)  for objects of type ns3::Object.  More... | |
| void | Initialize (void) | 
| Invoke DoInitialize on all Objects aggregated to this one.  More... | |
| bool | IsInitialized (void) const | 
| Check if the object has been initialized.  More... | |
|  Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
| SimpleRefCount () | |
| Default 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 operator.  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 | 
| Get the value of an attribute, raising fatal errors if unsuccessful.  More... | |
| bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const | 
| Get the value of an attribute without raising erros.  More... | |
| void | SetAttribute (std::string name, const AttributeValue &value) | 
| Set a single attribute, raising fatal errors if unsuccessful.  More... | |
| bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) | 
| Set a single attribute without raising errors.  More... | |
| bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) | 
| Connect a TraceSource to a Callback with a context.  More... | |
| bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) | 
| Connect a TraceSource to a Callback without a context.  More... | |
| bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) | 
| Disconnect from a TraceSource a Callback previously connected with a context.  More... | |
| bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) | 
| Disconnect from a TraceSource a Callback previously connected without a context.  More... | |
| Static Public Member Functions | |
| static TypeId | GetTypeId () | 
| Get the type ID.  More... | |
| static void | SetValueByPath (std::string path, Ptr< const Packet > packet, const Address &address) | 
| 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::ObjectBase | |
| static TypeId | GetTypeId (void) | 
| Get the type ID.  More... | |
| Private Member Functions | |
| void | TraceSink (Ptr< const Packet > packet, const Address &address) | 
| Method to connect to an underlying ns3::TraceSource with arguments of type Ptr<const Packet> and const Address&.  More... | |
| Private Attributes | |
| Address | m_address | 
| The socket address for the traced packet.  More... | |
| TracedCallback< Ptr< const Packet >, const Address & > | m_output | 
| Output trace, packet and source address.  More... | |
| TracedCallback< uint32_t, uint32_t > | m_outputBytes | 
| Output trace, previous packet size and current packet 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) | |
| Copy an Object.  More... | |
| virtual void | DoDispose (void) | 
| Destructor implementation.  More... | |
| virtual void | DoInitialize (void) | 
| Initialize() implementation.  More... | |
| virtual void | NotifyNewAggregate (void) | 
| Notify all Objects aggregated to this one of a new Object being aggregated.  More... | |
|  Protected Member Functions inherited from ns3::ObjectBase | |
| void | ConstructSelf (const AttributeConstructionList &attributes) | 
| Complete construction of ObjectBase; invoked by derived classes.  More... | |
| virtual void | NotifyConstructionCompleted (void) | 
| Notifier called once the ObjectBase is fully constructed.  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... | |
|  Related Functions inherited from ns3::ObjectBase | |
| static TypeId | GetObjectIid (void) | 
| Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.  More... | |
Probe to translate from a TraceSource to two more easily parsed TraceSources.
 Introspection did not find any typical Config paths.
This class is designed to probe an underlying ns3 TraceSource exporting a packet and a socket address. This probe exports a trace source "Output" with arguments of type Ptr<const Packet> and const Address&. This probe exports another trace source "OutputBytes" with arguments of type uint32_t, which is the number of bytes in the packet. The trace sources emit values when either the probed trace source emits a new value, or when SetValue () is called.
 No Attributes are defined for this type.
 
Size of this type is 128 bytes (on a 64-bit architecture).
Definition at line 51 of file application-packet-probe.h.
| ns3::ApplicationPacketProbe::ApplicationPacketProbe | ( | ) | 
Definition at line 57 of file application-packet-probe.cc.
References m_packet, and NS_LOG_FUNCTION.
| 
 | virtual | 
Definition at line 63 of file application-packet-probe.cc.
References NS_LOG_FUNCTION.
| 
 | virtual | 
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 91 of file application-packet-probe.cc.
References ns3::Names::FindPath(), ns3::MakeCallback(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::ObjectBase::TraceConnectWithoutContext(), and TraceSink().
 Here is the call graph for this function:
 Here is the call graph for this function:| 
 | 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 100 of file application-packet-probe.cc.
References ns3::Config::ConnectWithoutContext(), ns3::MakeCallback(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and TraceSink().
 Here is the call graph for this function:
 Here is the call graph for this function:| 
 | static | 
Get the type ID.
Definition at line 38 of file application-packet-probe.cc.
References m_output, m_outputBytes, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().
 Here is the call graph for this function:
 Here is the call graph for this function:Set a probe value.
| packet | set the traced packet equal to this | 
| address | set the socket address for the traced packet equal to this | 
Definition at line 69 of file application-packet-probe.cc.
References first::address, ns3::Packet::GetSize(), m_address, m_output, m_outputBytes, m_packet, m_packetSizeOld, and NS_LOG_FUNCTION.
 Here is the call graph for this function:
 Here is the call graph for this 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 | 
| address | set the socket address for the traced packet equal to this | 
Definition at line 82 of file application-packet-probe.cc.
References first::address, NS_ASSERT_MSG, and NS_LOG_FUNCTION.
| 
 | private | 
Method to connect to an underlying ns3::TraceSource with arguments of type Ptr<const Packet> and const Address&.
| packet | the traced packet | 
| address | the socket address for the traced packet | 
Definition at line 108 of file application-packet-probe.cc.
References first::address, ns3::Packet::GetSize(), ns3::Probe::IsEnabled(), m_address, m_output, m_outputBytes, m_packet, m_packetSizeOld, and NS_LOG_FUNCTION.
Referenced by ConnectByObject(), and ConnectByPath().
 Here is the call graph for this function:
 Here is the call graph for this function: Here is the caller graph for this function:
 Here is the caller graph for this function:| 
 | private | 
The socket address for the traced packet.
Definition at line 118 of file application-packet-probe.h.
Referenced by SetValue(), and TraceSink().
| 
 | private | 
Output trace, packet and source address.
Definition at line 110 of file application-packet-probe.h.
Referenced by GetTypeId(), SetValue(), and TraceSink().
| 
 | private | 
Output trace, previous packet size and current packet size.
Definition at line 112 of file application-packet-probe.h.
Referenced by GetTypeId(), SetValue(), and TraceSink().
The traced packet.
Definition at line 115 of file application-packet-probe.h.
Referenced by ApplicationPacketProbe(), SetValue(), and TraceSink().
| 
 | private | 
The size of the traced packet.
Definition at line 121 of file application-packet-probe.h.
Referenced by SetValue(), and TraceSink().