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 (Ipv4Address ip, uint16_t port, char *traceFile)
	Creates a traceBasedStreamer application.

	~UdpTraceClient () override

uint16_t	GetMaxPacketSize ()
	Return the maximum packet size.

void	SetMaxPacketSize (uint16_t maxPacketSize)
	Set the maximum packet size.

void	SetRemote (Address addr)
	set the remote address

void	SetRemote (Address ip, uint16_t port)
	set the remote address and port

void	SetTraceFile (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::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 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< 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) 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.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

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::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.

Private Member Functions
void	LoadDefaultTrace ()
	Load the default trace.

void	LoadTrace (std::string filename)
	Load a trace file.

void	Send ()
	Send a packet.

void	SendPacket (uint32_t size)
	Send a packet of a given size.

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)

Address	m_peerAddress
	Remote peer address.

uint16_t	m_peerPort
	Remote peer port.

EventId	m_sendEvent
	Event to send the next packet.

uint32_t	m_sent
	Counter for sent packets.

Ptr< Socket >	m_socket
	Socket.

uint8_t	m_tos
	The packets Type of Service.

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	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.

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 Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

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:

-1- the first one represents the frame index
-2- the second one indicates the type of the frame: I, P or B
-3- the third one indicates the time on which the frame was generated by the encoder (integer, milliseconds)
-4- the fourth one indicates the frame size in byte

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:

-1- consecutive 'B' frames are sent together,
-2- any trace file is (by default) read again once finished (loop).

The latter behavior can be changed through the "TraceLoop" attribute.

Config Paths

ns3::UdpTraceClient is accessible through the following paths with Config::Set and Config::Connect:

"/NodeList/[i]/ApplicationList/[i]/$ns3::UdpTraceClient"

Attributes

MaxPacketSize: The maximum size of a packet (including the SeqTsHeader, 12 bytes).
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 1024
- Flags: constructwriteread
RemoteAddress: The destination Address of the outbound packets
- Set with class: ns3::AddressValue
- Underlying type: Address
- Initial value:
- Flags: constructwriteread
RemotePort: The destination port of the outbound packets
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:65535
- Initial value: 100
- Flags: constructwriteread
Tos: The Type of Service used to send IPv4 packets. All 8 bits of the TOS byte are set (including ECN bits).
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 0
- Flags: constructwriteread
TraceFilename: Name of file to load a trace from. By default, uses a hardcoded trace.
- Set with class: ns3::StringValue
- Underlying type: std::string
- Initial value: ""
- Flags: constructwrite
TraceLoop: Loops through the trace file, starting again once it is over.
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: constructwrite

Attributes defined in parent class ns3::Application

StartTime: Time at which the application will start
- Set with class: ns3::TimeValue
- Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
- Initial value: +0ns
- Flags: constructwriteread
StopTime: Time at which the application will stop
- Set with class: ns3::TimeValue
- Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
- Initial value: +0ns
- Flags: constructwriteread

No TraceSources are defined for this type.
Size of this type is 232 bytes (on a 64-bit architecture).

Definition at line 63 of file udp-trace-client.h.

Constructor & Destructor Documentation

◆ UdpTraceClient() [1/2]

ns3::UdpTraceClient::UdpTraceClient ( )

Definition at line 108 of file udp-trace-client.cc.

References m_maxPacketSize, m_sendEvent, m_sent, m_socket, and NS_LOG_FUNCTION.

◆ UdpTraceClient() [2/2]

ns3::UdpTraceClient::UdpTraceClient	(	Ipv4Address	ip,
		uint16_t	port,
		char *	traceFile
	)

Creates a traceBasedStreamer application.

Parameters

ip	the destination ip address to which the stream will be sent
port	the destination udp port to which the stream will be sent
traceFile	a path to an MPEG4 trace file formatted as follows: FrameNo Frametype Time[ms] Length [byte] FrameNo Frametype Time[ms] Length [byte] ...

Definition at line 117 of file udp-trace-client.cc.

References m_currentEntry, m_maxPacketSize, m_peerAddress, m_peerPort, m_sendEvent, m_sent, m_socket, NS_LOG_FUNCTION, port, and SetTraceFile().

Here is the call graph for this function:

◆ ~UdpTraceClient()

ns3::UdpTraceClient::~UdpTraceClient ( )

override

Definition at line 133 of file udp-trace-client.cc.

References m_entries, and NS_LOG_FUNCTION.

Member Function Documentation

◆ GetMaxPacketSize()

uint16_t ns3::UdpTraceClient::GetMaxPacketSize ( )

Return the maximum packet size.

Returns: the maximum packet size

Definition at line 178 of file udp-trace-client.cc.

References m_maxPacketSize, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::UdpTraceClient::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 65 of file udp-trace-client.cc.

References m_maxPacketSize, m_peerAddress, m_peerPort, m_tos, ns3::MakeAddressAccessor(), ns3::MakeAddressChecker(), ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeStringAccessor(), ns3::MakeStringChecker(), ns3::MakeUintegerAccessor(), ns3::TypeId::SetParent(), SetTraceFile(), and SetTraceLoop().

Here is the call graph for this function:

◆ LoadDefaultTrace()

void ns3::UdpTraceClient::LoadDefaultTrace ( )

private

Load the default trace.

Definition at line 229 of file udp-trace-client.cc.

References ns3::UdpTraceClient::TraceEntry::frameType, g_defaultEntries, m_currentEntry, m_entries, NS_LOG_FUNCTION, prevTime, and ns3::UdpTraceClient::TraceEntry::timeToSend.

Referenced by LoadTrace(), and SetTraceFile().

Here is the caller graph for this function:

◆ LoadTrace()

void ns3::UdpTraceClient::LoadTrace ( std::string filename )

private

Load a trace file.

Parameters

filename the trace file path

Definition at line 185 of file udp-trace-client.cc.

References ns3::UdpTraceClient::TraceEntry::frameType, LoadDefaultTrace(), m_currentEntry, m_entries, NS_ASSERT_MSG, NS_LOG_FUNCTION, ns3::UdpTraceClient::TraceEntry::packetSize, prevTime, and ns3::UdpTraceClient::TraceEntry::timeToSend.

Referenced by SetTraceFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Send()

void ns3::UdpTraceClient::Send ( )

private

Send a packet.

Definition at line 359 of file udp-trace-client.cc.

References ns3::EventId::IsExpired(), 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:

◆ SendPacket()

void ns3::UdpTraceClient::SendPacket ( uint32_t size )

private

Send a packet of a given size.

Parameters

size	the packet size

Definition at line 315 of file udp-trace-client.cc.

References ns3::Ipv4Address::ConvertFrom(), ns3::Ipv6Address::ConvertFrom(), ns3::Ipv4Address::IsMatchingType(), ns3::Ipv6Address::IsMatchingType(), m_peerAddress, m_sent, m_socket, NS_LOG_FUNCTION, NS_LOG_INFO, packetSize, ns3::Socket::Send(), and ns3::SeqTsHeader::SetSeq().

Referenced by Send().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetMaxPacketSize()

void ns3::UdpTraceClient::SetMaxPacketSize ( uint16_t maxPacketSize )

Set the maximum packet size.

Parameters

maxPacketSize The maximum packet size

Definition at line 171 of file udp-trace-client.cc.

References m_maxPacketSize, and NS_LOG_FUNCTION.

◆ SetRemote() [1/2]

void ns3::UdpTraceClient::SetRemote ( Address addr )

set the remote address

Parameters

addr	remote address

Definition at line 149 of file udp-trace-client.cc.

References m_entries, m_peerAddress, and NS_LOG_FUNCTION.

◆ SetRemote() [2/2]

void ns3::UdpTraceClient::SetRemote	(	Address	ip,
		uint16_t	port
	)

set the remote address and port

Parameters

ip	remote IP address
port	remote port

Definition at line 140 of file udp-trace-client.cc.

References m_entries, m_peerAddress, m_peerPort, NS_LOG_FUNCTION, and port.

◆ SetTraceFile()

void ns3::UdpTraceClient::SetTraceFile ( std::string filename )

Set the trace file to be used by the application.

Parameters

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 157 of file udp-trace-client.cc.

References LoadDefaultTrace(), LoadTrace(), and NS_LOG_FUNCTION.

Referenced by UdpTraceClient(), and GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetTraceLoop()

void ns3::UdpTraceClient::SetTraceLoop ( bool traceLoop )

Set the trace loop flag.

Parameters

traceLoop true if the trace should be re-used

Definition at line 395 of file udp-trace-client.cc.

References m_traceLoop.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ StartApplication()

void ns3::UdpTraceClient::StartApplication ( )

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 252 of file udp-trace-client.cc.

References ns3::Socket::Bind(), ns3::Socket::Bind6(), ns3::Socket::Connect(), ns3::Ipv4Address::ConvertFrom(), ns3::Ipv6Address::ConvertFrom(), ns3::Socket::CreateSocket(), ns3::Application::GetNode(), ns3::Address::IsInvalid(), ns3::Inet6SocketAddress::IsMatchingType(), ns3::InetSocketAddress::IsMatchingType(), ns3::Ipv4Address::IsMatchingType(), ns3::Ipv6Address::IsMatchingType(), ns3::TypeId::LookupByName(), m_peerAddress, m_peerPort, m_sendEvent, m_socket, m_tos, ns3::MakeNullCallback(), NS_ABORT_MSG_IF, NS_ASSERT_MSG, NS_FATAL_ERROR, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), ns3::Seconds(), Send(), ns3::Socket::SetAllowBroadcast(), ns3::Socket::SetIpTos(), and ns3::Socket::SetRecvCallback().

Here is the call graph for this function:

◆ StopApplication()

void ns3::UdpTraceClient::StopApplication ( )

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 308 of file udp-trace-client.cc.

References ns3::Simulator::Cancel(), m_sendEvent, and NS_LOG_FUNCTION.

Here is the call graph for this function:

Member Data Documentation

◆ g_defaultEntries

UdpTraceClient::TraceEntry ns3::UdpTraceClient::g_defaultEntries

staticprivate

Initial value:

= {
    {0, 534, 'I'},
    {40, 1542, 'P'},
    {120, 134, 'B'},
    {80, 390, 'B'},
    {240, 765, 'P'},
    {160, 407, 'B'},
    {200, 504, 'B'},
    {360, 903, 'P'},
    {280, 421, 'B'},
    {320, 587, 'B'},
}

Default trace to send.

Definition at line 172 of file udp-trace-client.h.

Referenced by LoadDefaultTrace().

◆ m_currentEntry

uint32_t ns3::UdpTraceClient::m_currentEntry

private

Current entry index.

Definition at line 171 of file udp-trace-client.h.

Referenced by UdpTraceClient(), LoadDefaultTrace(), LoadTrace(), and Send().

◆ m_entries

std::vector<TraceEntry> ns3::UdpTraceClient::m_entries

private

Entries in the trace to send.

Definition at line 170 of file udp-trace-client.h.

Referenced by ~UdpTraceClient(), LoadDefaultTrace(), LoadTrace(), Send(), and SetRemote().

◆ m_maxPacketSize

uint16_t ns3::UdpTraceClient::m_maxPacketSize

private

Maximum packet size to send (including the SeqTsHeader)

Definition at line 173 of file udp-trace-client.h.

Referenced by UdpTraceClient(), GetMaxPacketSize(), GetTypeId(), Send(), and SetMaxPacketSize().

◆ m_peerAddress

Address ns3::UdpTraceClient::m_peerAddress

private

Remote peer address.

Definition at line 165 of file udp-trace-client.h.

Referenced by UdpTraceClient(), GetTypeId(), SendPacket(), SetRemote(), and StartApplication().

◆ m_peerPort

uint16_t ns3::UdpTraceClient::m_peerPort

private

Remote peer port.

Definition at line 166 of file udp-trace-client.h.

Referenced by UdpTraceClient(), GetTypeId(), SetRemote(), and StartApplication().

◆ m_sendEvent

EventId ns3::UdpTraceClient::m_sendEvent

private

Event to send the next packet.

Definition at line 168 of file udp-trace-client.h.

Referenced by UdpTraceClient(), Send(), StartApplication(), and StopApplication().

◆ m_sent

uint32_t ns3::UdpTraceClient::m_sent

private

Counter for sent packets.

Definition at line 163 of file udp-trace-client.h.

Referenced by UdpTraceClient(), and SendPacket().

◆ m_socket

Ptr<Socket> ns3::UdpTraceClient::m_socket

private

Socket.

Definition at line 164 of file udp-trace-client.h.

Referenced by UdpTraceClient(), SendPacket(), and StartApplication().

◆ m_tos

uint8_t ns3::UdpTraceClient::m_tos

private

The packets Type of Service.

Definition at line 167 of file udp-trace-client.h.

Referenced by GetTypeId(), and StartApplication().

◆ m_traceLoop

bool ns3::UdpTraceClient::m_traceLoop

private

Loop through the trace file.

Definition at line 174 of file udp-trace-client.h.

Referenced by Send(), and SetTraceLoop().

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

src/applications/model/udp-trace-client.h
src/applications/model/udp-trace-client.cc

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::Application

Constructor & Destructor Documentation

◆ UdpTraceClient() [1/2]

◆ UdpTraceClient() [2/2]

◆ ~UdpTraceClient()

Member Function Documentation

◆ GetMaxPacketSize()

◆ GetTypeId()

◆ LoadDefaultTrace()

◆ LoadTrace()

◆ Send()

◆ SendPacket()

◆ SetMaxPacketSize()

◆ SetRemote() [1/2]

◆ SetRemote() [2/2]

◆ SetTraceFile()

◆ SetTraceLoop()

◆ StartApplication()

◆ StopApplication()

Member Data Documentation

◆ g_defaultEntries

◆ m_currentEntry

◆ m_entries

◆ m_maxPacketSize

◆ m_peerAddress

◆ m_peerPort

◆ m_sendEvent

◆ m_sent

◆ m_socket

◆ m_tos

◆ m_traceLoop