A trace based streamer. More...

#include <udp-trace-client.h>

Inheritance diagram for ns3::UdpTraceClient:

Collaboration diagram for ns3::UdpTraceClient:

Classes
struct	TraceEntry

Public Member Functions
	UdpTraceClient ()
	creates a traceBasedStreamer application More...

	UdpTraceClient (Ipv4Address ip, uint16_t port, char *traceFile)
	creates a traceBasedStreamer application More...

	~UdpTraceClient ()

uint16_t	GetMaxPacketSize (void)

void	SetMaxPacketSize (uint16_t maxPacketSize)

void	SetRemote (Address ip, uint16_t port)
	set the destination IP address and port More...

void	SetRemote (Ipv4Address ip, uint16_t port)

void	SetRemote (Ipv6Address ip, uint16_t port)

void	SetTraceFile (std::string filename)
	set the trace file to be used by the application More...

Public Member Functions inherited from ns3::Application
	Application ()

virtual	~Application ()

Ptr< Node >	GetNode () const

void	SetNode (Ptr< Node > node)

void	SetStartTime (Time start)
	Specify application start time. More...

void	SetStopTime (Time stop)
	Specify application stop time. More...

Public Member Functions inherited from ns3::Object
	Object ()

virtual	~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 ()

	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
virtual	~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::Application
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)

Protected Member Functions
virtual void	DoDispose (void)

Protected Member Functions inherited from ns3::Application
virtual void	DoInitialize (void)

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	NotifyNewAggregate (void)

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)

Private Member Functions
void	LoadDefaultTrace (void)

void	LoadTrace (std::string filename)

void	ScheduleTransmit (Time dt)

void	Send (void)

void	SendPacket (uint32_t size)

virtual void	StartApplication (void)
	Application specific startup code. More...

virtual void	StopApplication (void)
	Application specific shutdown code. More...

Private Attributes
uint32_t	m_currentEntry

std::vector< struct TraceEntry >	m_entries

uint16_t	m_maxPacketSize

Address	m_peerAddress

uint16_t	m_peerPort

EventId	m_sendEvent

uint32_t	m_sent

Ptr< Socket >	m_socket

Static Private Attributes
static struct TraceEntry	g_defaultEntries []

Additional Inherited Members
Protected Attributes inherited from ns3::Application
Ptr< Node >	m_node

EventId	m_startEvent

Time	m_startTime

EventId	m_stopEvent

Time	m_stopTime

Detailed Description

A trace based streamer.

Config Paths

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

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

Attributes

RemoteAddress: The destination Address of the outbound packets
- Set with class: AddressValue
- Underlying type: Address
- Initial value: 00-00-00
- Flags: construct write read
RemotePort: The destination port of the outbound packets
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:65535
- Initial value: 100
- Flags: construct write read
MaxPacketSize: The maximum size of a packet.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 1024
- Flags: construct write read
TraceFilename: Name of file to load a trace from. By default, uses a hardcoded trace.
- Set with class: StringValue
- Underlying type: std::string
- Initial value:
- Flags: construct write

Attributes defined in parent class ns3::Application

StartTime: Time at which the application will start
- Set with class: ns3::TimeValue
- Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +0.0ns
- Flags: construct write read
StopTime: Time at which the application will stop
- Set with class: ns3::TimeValue
- Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +0.0ns
- Flags: construct write read

No TraceSources are defined for this type.

sends udp packets based on a trace file of an MPEG4 stream trace files could be downloaded form : http://www.tkn.tu-berlin.de/research/trace/ltvt.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 -4- the fourth one indicates the frame size in byte if no valid MPEG4 trace file is provided to the application the trace from g_defaultEntries array will be loaded.

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

Constructor & Destructor Documentation

ns3::UdpTraceClient::UdpTraceClient ( )

creates a traceBasedStreamer application

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

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

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

ns3::UdpTraceClient::~UdpTraceClient ( )

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

References m_entries, and NS_LOG_FUNCTION.

Member Function Documentation

void ns3::UdpTraceClient::DoDispose ( void )

protectedvirtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

It is safe to call GetObject from within this method.

Reimplemented from ns3::Application.

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

References ns3::Application::DoDispose(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

uint16_t ns3::UdpTraceClient::GetMaxPacketSize ( void )

Returns: the maximum packet size

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

References m_maxPacketSize, and NS_LOG_FUNCTION.

TypeId ns3::UdpTraceClient::GetTypeId ( void )

static

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

References m_maxPacketSize, m_peerAddress, m_peerPort, ns3::TypeId::SetParent(), and SetTraceFile().

Referenced by ns3::UdpTraceClientHelper::UdpTraceClientHelper().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::UdpTraceClient::LoadDefaultTrace ( void )

private

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

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

Referenced by LoadTrace(), and SetTraceFile().

Here is the caller graph for this function:

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

private

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

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

Referenced by SetTraceFile().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::UdpTraceClient::ScheduleTransmit ( Time dt )

private

void ns3::UdpTraceClient::Send ( void )

private

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

References ns3::EventId::IsExpired(), m_currentEntry, m_entries, m_maxPacketSize, m_sendEvent, NS_ASSERT, NS_LOG_FUNCTION, ns3::UdpTraceClient::TraceEntry::packetSize, ns3::Simulator::Schedule(), SendPacket(), and ns3::UdpTraceClient::TraceEntry::timeToSend.

Referenced by StartApplication().

Here is the call graph for this function:

Here is the caller graph for this function:

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

private

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

References ns3::Packet::AddHeader(), ns3::Ipv4Address::ConvertFrom(), ns3::Ipv6Address::ConvertFrom(), ns3::Ipv4Address::IsMatchingType(), ns3::Ipv6Address::IsMatchingType(), m_peerAddress, m_sent, m_socket, NS_LOG_FUNCTION, NS_LOG_INFO, 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:

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

Parameters

maxPacketSize The maximum packet size

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

References m_maxPacketSize, and NS_LOG_FUNCTION.

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

set the destination IP address and port

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

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

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

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

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

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

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

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

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

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

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

Referenced by GetTypeId(), and UdpTraceClient().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::UdpTraceClient::StartApplication ( void )

privatevirtual

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 241 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::Ipv4Address::IsMatchingType(), ns3::Ipv6Address::IsMatchingType(), ns3::TypeId::LookupByName(), m_peerAddress, m_peerPort, m_sendEvent, m_socket, ns3::MakeNullCallback(), NS_LOG_FUNCTION, ns3::Simulator::Schedule(), Send(), and ns3::Socket::SetRecvCallback().

Here is the call graph for this function:

void ns3::UdpTraceClient::StopApplication ( void )

privatevirtual

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

struct TraceEntry ns3::UdpTraceClient::g_defaultEntries[]

staticprivate

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

Referenced by LoadDefaultTrace().

uint32_t ns3::UdpTraceClient::m_currentEntry

private

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

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

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

private

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

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

uint16_t ns3::UdpTraceClient::m_maxPacketSize

private

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

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

Address ns3::UdpTraceClient::m_peerAddress

private

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

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

uint16_t ns3::UdpTraceClient::m_peerPort

private

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

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

EventId ns3::UdpTraceClient::m_sendEvent

private

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

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

uint32_t ns3::UdpTraceClient::m_sent

private

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

Referenced by SendPacket(), and UdpTraceClient().

Ptr<Socket> ns3::UdpTraceClient::m_socket

private

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

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

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

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

Classes

Public Member Functions

Static Public Member Functions

Protected 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

Member Function Documentation

Member Data Documentation