Tutorial - a simple Application sending packets. More...

#include "tutorial-app.h"

Inheritance diagram for ns3::TutorialApp:

Collaboration diagram for ns3::TutorialApp:

Public Member Functions
	TutorialApp ()

	~TutorialApp () override

void	Setup (Ptr< Socket > socket, Address address, uint32_t packetSize, uint32_t nPackets, DataRate dataRate)
	Setup the socket.

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 ()
	Register this type.

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	ScheduleTx ()
	Schedule a new transmission.

void	SendPacket ()
	Send a packet.

void	StartApplication () override
	Application specific startup code.

void	StopApplication () override
	Application specific shutdown code.

Private Attributes
DataRate	m_dataRate
	The data rate to use.

uint32_t	m_nPackets
	The number of packets to send.

uint32_t	m_packetSize
	The packet size.

uint32_t	m_packetsSent
	The number of packets sent.

Address	m_peer
	The destination address.

bool	m_running
	True if the application is running.

EventId	m_sendEvent
	Send event.

Ptr< Socket >	m_socket
	The transmission socket.

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

Tutorial - a simple Application sending packets.

Definition at line 31 of file tutorial-app.h.

Constructor & Destructor Documentation

◆ TutorialApp()

TutorialApp::TutorialApp ( )

Definition at line 22 of file tutorial-app.cc.

◆ ~TutorialApp()

TutorialApp::~TutorialApp ( )

override

Definition at line 34 of file tutorial-app.cc.

References m_socket.

Member Function Documentation

◆ GetTypeId()

TypeId TutorialApp::GetTypeId ( )

static

Register this type.

Returns: The TypeId.

Definition at line 41 of file tutorial-app.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ ScheduleTx()

void TutorialApp::ScheduleTx ( )

private

Schedule a new transmission.

Definition at line 103 of file tutorial-app.cc.

References ns3::DataRate::GetBitRate(), m_dataRate, m_packetSize, m_running, m_sendEvent, ns3::Simulator::Schedule(), ns3::Seconds(), and SendPacket().

Referenced by SendPacket().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendPacket()

void TutorialApp::SendPacket ( )

private

Send a packet.

Definition at line 91 of file tutorial-app.cc.

References m_nPackets, m_packetSize, m_packetsSent, m_socket, ScheduleTx(), and ns3::Socket::Send().

Referenced by ScheduleTx(), and StartApplication().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Setup()

void TutorialApp::Setup	(	Ptr< Socket >	socket,
		Address	address,
		uint32_t	packetSize,
		uint32_t	nPackets,
		DataRate	dataRate
	)

Setup the socket.

Parameters

socket	The socket.
address	The destination address.
packetSize	The packet size to transmit.
nPackets	The number of packets to transmit.
dataRate	the data rate to use.

Definition at line 51 of file tutorial-app.cc.

References m_dataRate, m_nPackets, m_packetSize, m_peer, m_socket, and packetSize.

◆ StartApplication()

void TutorialApp::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 65 of file tutorial-app.cc.

References ns3::Socket::Bind(), ns3::Socket::Connect(), m_packetsSent, m_peer, m_running, m_socket, and SendPacket().

Here is the call graph for this function:

◆ StopApplication()

void TutorialApp::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 75 of file tutorial-app.cc.

References ns3::Simulator::Cancel(), ns3::Socket::Close(), ns3::EventId::IsRunning(), m_running, m_sendEvent, and m_socket.

Here is the call graph for this function:

Member Data Documentation

◆ m_dataRate

DataRate ns3::TutorialApp::m_dataRate

private

The data rate to use.

Definition at line 70 of file tutorial-app.h.

Referenced by ScheduleTx(), and Setup().

◆ m_nPackets

uint32_t ns3::TutorialApp::m_nPackets

private

The number of packets to send.

Definition at line 69 of file tutorial-app.h.

Referenced by SendPacket(), and Setup().

◆ m_packetSize

uint32_t ns3::TutorialApp::m_packetSize

private

The packet size.

Definition at line 68 of file tutorial-app.h.

Referenced by ScheduleTx(), SendPacket(), and Setup().

◆ m_packetsSent

uint32_t ns3::TutorialApp::m_packetsSent

private

The number of packets sent.

Definition at line 73 of file tutorial-app.h.

Referenced by SendPacket(), and StartApplication().

◆ m_peer

Address ns3::TutorialApp::m_peer

private

The destination address.

Definition at line 67 of file tutorial-app.h.

Referenced by Setup(), and StartApplication().

◆ m_running

bool ns3::TutorialApp::m_running

private

True if the application is running.

Definition at line 72 of file tutorial-app.h.

Referenced by ScheduleTx(), StartApplication(), and StopApplication().

◆ m_sendEvent

EventId ns3::TutorialApp::m_sendEvent

private

Send event.

Definition at line 71 of file tutorial-app.h.

Referenced by ScheduleTx(), and StopApplication().

◆ m_socket

Ptr<Socket> ns3::TutorialApp::m_socket

private

The transmission socket.

Definition at line 66 of file tutorial-app.h.

Referenced by ~TutorialApp(), SendPacket(), Setup(), StartApplication(), and StopApplication().

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

examples/tutorial/tutorial-app.h
examples/tutorial/tutorial-app.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TutorialApp()

◆ ~TutorialApp()

Member Function Documentation

◆ GetTypeId()

◆ ScheduleTx()

◆ SendPacket()

◆ Setup()

◆ StartApplication()

◆ StopApplication()

Member Data Documentation

◆ m_dataRate

◆ m_nPackets

◆ m_packetSize

◆ m_packetsSent

◆ m_peer

◆ m_running

◆ m_sendEvent

◆ m_socket