A trace based streamer. More...
#include "udp-trace-client.h"
Inheritance diagram for ns3::UdpTraceClient:
Collaboration diagram for ns3::UdpTraceClient:Classes | |
| struct | TraceEntry |
| Entry to send. More... | |
Public Member Functions | |
| UdpTraceClient () | |
| ~UdpTraceClient () override | |
| uint16_t | GetMaxPacketSize () |
| Return the maximum packet size. | |
| void | SetMaxPacketSize (uint16_t maxPacketSize) |
| Set the maximum packet size. | |
| void | SetRemote (const Address &addr) override |
| set the remote address | |
| void | SetRemote (const Address &ip, uint16_t port) |
| set the remote address and port | |
| void | SetTraceFile (const std::string &filename) |
| Set the trace file to be used by the application. | |
| void | SetTraceLoop (bool traceLoop) |
| Set the trace loop flag. | |
Public Member Functions inherited from ns3::SourceApplication | |
| SourceApplication () | |
| ~SourceApplication () override | |
| Address | GetRemote () const |
| get the remote address | |
Public Member Functions inherited from ns3::Application | |
| Application () | |
| ~Application () override | |
| virtual int64_t | AssignStreams (int64_t stream) |
| Assign a fixed random variable stream number to the random variables used by this Application object. | |
| Ptr< Node > | GetNode () const |
| void | SetNode (Ptr< Node > node) |
| void | SetStartTime (Time start) |
| Specify application start time. | |
| void | SetStopTime (Time stop) |
| Specify application stop time. | |
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 final |
| 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::SourceApplication | |
| static TypeId | GetTypeId () |
| Get the type ID. | |
Static Public Member Functions inherited from ns3::Application | |
| 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. | |
Static Public Attributes | |
| static constexpr uint16_t | DEFAULT_PORT {100} |
| default port | |
Private Member Functions | |
| uint16_t | GetPort () const |
| Get the remote port (temporary function until deprecated attributes are removed) | |
| Address | GetRemote () const |
| Get the remote address (temporary function until deprecated attributes are removed) | |
| void | LoadDefaultTrace () |
| Load the default trace. | |
| void | LoadTrace () |
| Load current trace file. | |
| void | Send () |
| Send a packet. | |
| void | SendPacket (uint32_t size) |
| Send a packet of a given size. | |
| void | SetPort (uint16_t port) |
| Set the remote port (temporary function until deprecated attributes are removed) | |
| void | StartApplication () override |
| Application specific startup code. | |
| void | StopApplication () override |
| Application specific shutdown code. | |
Private Attributes | |
| uint32_t | m_currentEntry |
| Current entry index. | |
| std::vector< TraceEntry > | m_entries |
| Entries in the trace to send. | |
| uint16_t | m_maxPacketSize |
| Maximum packet size to send (including the SeqTsHeader) | |
| std::optional< uint16_t > | m_peerPort |
| Remote peer port (deprecated) // NS_DEPRECATED_3_44. | |
| EventId | m_sendEvent |
| Event to send the next packet. | |
| uint32_t | m_sent |
| Counter for sent packets. | |
| Ptr< Socket > | m_socket |
| Socket. | |
| std::string | m_traceFile |
| The location of the trace file. | |
| bool | m_traceLoop |
| Loop through the trace file. | |
Static Private Attributes | |
| static TraceEntry | g_defaultEntries [] |
| Default trace to send. | |
Additional Inherited Members | |
Public Types inherited from ns3::Application | |
| typedef void(* | DelayAddressCallback) (const Time &delay, const Address &from) |
| Common callback signature for packet delay and address. | |
| typedef void(* | StateTransitionCallback) (const std::string &oldState, const std::string &newState) |
| Common signature used by callbacks to application's state transition trace source. | |
Protected Member Functions inherited from ns3::Application | |
| void | DoDispose () override |
| Destructor implementation. | |
| void | DoInitialize () override |
| Initialize() implementation. | |
Protected Member Functions inherited from ns3::Object | |
| Object (const Object &o) | |
| Copy an Object. | |
| 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. | |
Protected Attributes inherited from ns3::SourceApplication | |
| Address | m_local |
| Local address to bind to. | |
| Address | m_peer |
| Peer address. | |
| uint8_t | m_tos |
| The packets Type of Service. | |
Protected Attributes inherited from ns3::Application | |
| Ptr< Node > | m_node |
| The node that this application is installed on. | |
| EventId | m_startEvent |
| The event that will fire at m_startTime to start the application. | |
| Time | m_startTime |
| The simulation time that the application will start. | |
| EventId | m_stopEvent |
| The event that will fire at m_stopTime to end the application. | |
| Time | m_stopTime |
| The simulation time that the application will end. | |
Related Symbols inherited from ns3::ObjectBase | |
| static TypeId | GetObjectIid () |
| Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
A trace based streamer.
Sends UDP packets based on a trace file of a MPEG4 stream. Trace files can be downloaded from: https://web.archive.org/web/20210113211420/http://trace.eas.asu.edu/mpeg4/index.html (the 2 first lines of the file should be removed) A valid trace file is a file with 4 columns:
Additional trace files can be generated from MPEG4 files using the tool available in https://pypi.org/project/trace-extractor/
If no valid MPEG4 trace file is provided to the application the trace from g_defaultEntries array will be loaded.
Also note that:
The latter behavior can be changed through the "TraceLoop" attribute.
ns3::UdpTraceClient is accessible through the following paths with Config::Set and Config::Connect:
Address std::string Address Address Time -9.22337e+18ns:+9.22337e+18ns Time -9.22337e+18ns:+9.22337e+18ns No TraceSources are defined for this type
Group: Applications
Size of this type is 288 bytes (on a 64-bit architecture).
Definition at line 54 of file udp-trace-client.h.
| ns3::UdpTraceClient::UdpTraceClient | ( | ) |
Definition at line 104 of file udp-trace-client.cc.
References m_currentEntry, m_peerPort, m_sendEvent, m_sent, m_socket, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
Here is the caller graph for this function:
|
override |
Definition at line 114 of file udp-trace-client.cc.
References NS_LOG_FUNCTION.
| uint16_t ns3::UdpTraceClient::GetMaxPacketSize | ( | ) |
Return the maximum packet size.
Definition at line 198 of file udp-trace-client.cc.
References m_maxPacketSize, and NS_LOG_FUNCTION.
|
private |
Get the remote port (temporary function until deprecated attributes are removed)
Definition at line 165 of file udp-trace-client.cc.
References ns3::Inet6SocketAddress::ConvertFrom(), ns3::InetSocketAddress::ConvertFrom(), DEFAULT_PORT, ns3::Inet6SocketAddress::GetPort(), ns3::InetSocketAddress::GetPort(), ns3::Inet6SocketAddress::IsMatchingType(), ns3::InetSocketAddress::IsMatchingType(), ns3::SourceApplication::m_peer, and m_peerPort.
Here is the call graph for this function:
|
private |
Get the remote address (temporary function until deprecated attributes are removed)
Definition at line 143 of file udp-trace-client.cc.
References ns3::SourceApplication::m_peer.
Referenced by GetTypeId().
Here is the caller graph for this function:
|
static |
Get the type ID.
Definition at line 52 of file udp-trace-client.cc.
References ns3::SourceApplication::SourceApplication(), UdpTraceClient(), DEFAULT_PORT, ns3::TypeId::DEPRECATED, GetRemote(), m_maxPacketSize, ns3::MakeAddressAccessor(), ns3::MakeAddressChecker(), ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeStringAccessor(), ns3::MakeStringChecker(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), ns3::TypeId::SetParent(), SetRemote(), SetTraceFile(), and SetTraceLoop().
Here is the call graph for this function:
|
private |
Load the default trace.
Definition at line 261 of file udp-trace-client.cc.
References ns3::UdpTraceClient::TraceEntry::frameType, g_defaultEntries, m_entries, NS_LOG_FUNCTION, prevTime, and ns3::UdpTraceClient::TraceEntry::timeToSend.
Referenced by LoadTrace().
Here is the caller graph for this function:
|
private |
Load current trace file.
Definition at line 205 of file udp-trace-client.cc.
References LoadDefaultTrace(), m_currentEntry, m_entries, m_traceFile, NS_ASSERT_MSG, NS_LOG_FUNCTION, ns3::UdpTraceClient::TraceEntry::packetSize, and prevTime.
Referenced by SetRemote(), and SetTraceFile().
Here is the call graph for this function:
Here is the caller graph for this function:
|
private |
Send a packet.
Definition at line 384 of file udp-trace-client.cc.
References m_currentEntry, m_entries, m_maxPacketSize, m_sendEvent, m_traceLoop, ns3::MilliSeconds(), NS_ASSERT, NS_LOG_FUNCTION, ns3::UdpTraceClient::TraceEntry::packetSize, ns3::Simulator::Schedule(), Send(), SendPacket(), and ns3::UdpTraceClient::TraceEntry::timeToSend.
Referenced by Send(), and StartApplication().
Here is the call graph for this function:
Here is the caller graph for this function:
|
private |
Send a packet of a given size.
| size | the packet size |
Definition at line 341 of file udp-trace-client.cc.
References ns3::Inet6SocketAddress::ConvertFrom(), ns3::InetSocketAddress::ConvertFrom(), ns3::Create(), ns3::InetSocketAddress::GetIpv4(), ns3::Inet6SocketAddress::GetIpv6(), ns3::Inet6SocketAddress::GetPort(), ns3::InetSocketAddress::GetPort(), ns3::Inet6SocketAddress::IsMatchingType(), ns3::InetSocketAddress::IsMatchingType(), ns3::SourceApplication::m_peer, m_sent, m_socket, NS_LOG_FUNCTION, NS_LOG_INFO, packetSize, and ns3::SeqTsHeader::SetSeq().
Referenced by Send().
Here is the call graph for this function:
Here is the caller graph for this function:| void ns3::UdpTraceClient::SetMaxPacketSize | ( | uint16_t | maxPacketSize | ) |
Set the maximum packet size.
| maxPacketSize | The maximum packet size |
Definition at line 191 of file udp-trace-client.cc.
References m_maxPacketSize, and NS_LOG_FUNCTION.
|
private |
Set the remote port (temporary function until deprecated attributes are removed)
| port | remote port |
Definition at line 149 of file udp-trace-client.cc.
References ns3::addressUtils::ConvertToSocketAddress(), ns3::Ipv4Address::IsMatchingType(), ns3::Ipv6Address::IsMatchingType(), ns3::SourceApplication::m_peer, m_peerPort, NS_LOG_FUNCTION, and port.
Referenced by SetRemote(), and SetRemote().
Here is the call graph for this function:
Here is the caller graph for this function:
|
overridevirtual |
set the remote address
| addr | remote address |
Reimplemented from ns3::SourceApplication.
Definition at line 128 of file udp-trace-client.cc.
References ns3::Address::IsInvalid(), LoadTrace(), ns3::SourceApplication::m_peer, m_peerPort, NS_LOG_FUNCTION, and SetPort().
Here is the call graph for this function:| void ns3::UdpTraceClient::SetRemote | ( | const Address & | ip, |
| uint16_t | port ) |
set the remote address and port
| ip | remote IP address |
| port | remote port |
Definition at line 120 of file udp-trace-client.cc.
References NS_LOG_FUNCTION, port, SetPort(), and SetRemote().
Referenced by GetTypeId(), and SetRemote().
Here is the call graph for this function:
Here is the caller graph for this function:| void ns3::UdpTraceClient::SetTraceFile | ( | const std::string & | filename | ) |
Set the trace file to be used by the application.
| filename | a path to an MPEG4 trace file formatted as follows: Frame No Frametype Time[ms] Length [byte] Frame No Frametype Time[ms] Length [byte] ... |
Definition at line 183 of file udp-trace-client.cc.
References LoadTrace(), m_traceFile, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
Here is the call graph for this function:
Here is the caller graph for this function:| void ns3::UdpTraceClient::SetTraceLoop | ( | bool | traceLoop | ) |
Set the trace loop flag.
| traceLoop | true if the trace should be re-used |
Definition at line 420 of file udp-trace-client.cc.
References m_traceLoop.
Referenced by GetTypeId().
Here is the caller graph for this function:
|
overrideprivatevirtual |
Application specific startup code.
The StartApplication method is called at the start time specified by Start This method should be overridden by all or most application subclasses.
Reimplemented from ns3::Application.
Definition at line 283 of file udp-trace-client.cc.
References ns3::Socket::CreateSocket(), ns3::Application::GetNode(), ns3::Inet6SocketAddress::IsMatchingType(), ns3::InetSocketAddress::IsMatchingType(), ns3::TypeId::LookupByName(), ns3::SourceApplication::m_local, ns3::SourceApplication::m_peer, m_sendEvent, m_socket, ns3::SourceApplication::m_tos, ns3::MakeNullCallback(), NS_ABORT_MSG_IF, NS_ASSERT_MSG, NS_FATAL_ERROR, NS_LOG_FUNCTION, ns3::Simulator::ScheduleNow(), and Send().
Here is the call graph for this function:
|
overrideprivatevirtual |
Application specific shutdown code.
The StopApplication method is called at the stop time specified by Stop This method should be overridden by all or most application subclasses.
Reimplemented from ns3::Application.
Definition at line 334 of file udp-trace-client.cc.
References ns3::Simulator::Cancel(), m_sendEvent, and NS_LOG_FUNCTION.
Here is the call graph for this function:
|
staticconstexpr |
default port
Definition at line 66 of file udp-trace-client.h.
Referenced by GetPort(), and GetTypeId().
|
staticprivate |
Default trace to send.
Definition at line 166 of file udp-trace-client.h.
Referenced by LoadDefaultTrace().
|
private |
Current entry index.
Definition at line 165 of file udp-trace-client.h.
Referenced by UdpTraceClient(), LoadTrace(), and Send().
|
private |
Entries in the trace to send.
Definition at line 164 of file udp-trace-client.h.
Referenced by LoadDefaultTrace(), LoadTrace(), and Send().
|
private |
Maximum packet size to send (including the SeqTsHeader)
Definition at line 167 of file udp-trace-client.h.
Referenced by GetMaxPacketSize(), GetTypeId(), Send(), and SetMaxPacketSize().
|
private |
Remote peer port (deprecated) // NS_DEPRECATED_3_44.
Definition at line 161 of file udp-trace-client.h.
Referenced by UdpTraceClient(), GetPort(), SetPort(), and SetRemote().
|
private |
Event to send the next packet.
Definition at line 162 of file udp-trace-client.h.
Referenced by UdpTraceClient(), Send(), StartApplication(), and StopApplication().
|
private |
Counter for sent packets.
Definition at line 159 of file udp-trace-client.h.
Referenced by UdpTraceClient(), and SendPacket().
Definition at line 160 of file udp-trace-client.h.
Referenced by UdpTraceClient(), SendPacket(), and StartApplication().
|
private |
The location of the trace file.
Definition at line 169 of file udp-trace-client.h.
Referenced by LoadTrace(), and SetTraceFile().
|
private |
Loop through the trace file.
Definition at line 168 of file udp-trace-client.h.
Referenced by Send(), and SetTraceLoop().