#include "wifi-example-apps.h"

Inheritance diagram for Sender:

Collaboration diagram for Sender:

Public Member Functions
	Sender ()

	~Sender () override

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.

Protected Member Functions
void	DoDispose () override
	Destructor implementation.

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.

Private Member Functions
void	SendPacket ()
	Send a packet.

void	StartApplication () override
	Application specific startup code.

void	StopApplication () override
	Application specific shutdown code.

Private Attributes
uint32_t	m_count {0}
	Number of packets sent.

Ipv4Address	m_destAddr
	Destination address.

uint32_t	m_destPort {0}
	Destination port.

Ptr< ConstantRandomVariable >	m_interval
	Rng for sending packets.

uint32_t	m_nPackets {0}
	Number of packets to send.

uint32_t	m_packetSize {0}
	The packet size.

EventId	m_sendEvent
	Send packet event.

Ptr< Socket >	m_socket
	Sending socket.

TracedCallback< Ptr< const Packet > >	m_txTrace
	Tx TracedCallback.

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

Sender application.

Definition at line 41 of file wifi-example-apps.h.

Constructor & Destructor Documentation

◆ Sender()

Sender::Sender ( )

Definition at line 82 of file wifi-example-apps.cc.

References m_interval, and NS_LOG_FUNCTION_NOARGS.

◆ ~Sender()

Sender::~Sender ( )

override

Definition at line 88 of file wifi-example-apps.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ DoDispose()

void Sender::DoDispose ( )

overrideprotectedvirtual

Destructor implementation.

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

Subclasses are expected to implement their real destruction code in an overridden 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::Object.

Definition at line 94 of file wifi-example-apps.cc.

References ns3::Application::DoDispose(), m_socket, and NS_LOG_FUNCTION_NOARGS.

Here is the call graph for this function:

◆ GetTypeId()

TypeId Sender::GetTypeId ( )

static

Get the type ID.

Returns: The object TypeId.

Definition at line 45 of file wifi-example-apps.cc.

References m_destAddr, m_destPort, m_interval, m_nPackets, m_packetSize, m_txTrace, ns3::MakeIpv4AddressAccessor(), ns3::MakeIpv4AddressChecker(), ns3::MakePointerAccessor(), ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ SendPacket()

void Sender::SendPacket ( )

private

Send a packet.

Definition at line 130 of file wifi-example-apps.cc.

References ns3::ConstantRandomVariable::GetValue(), m_count, m_destAddr, m_destPort, m_interval, m_nPackets, m_packetSize, m_sendEvent, m_socket, m_txTrace, ns3::Simulator::Now(), NS_LOG_INFO, ns3::Simulator::Schedule(), ns3::Seconds(), SendPacket(), ns3::Socket::SendTo(), and ns3::TimestampTag::SetTimestamp().

Referenced by SendPacket(), and StartApplication().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StartApplication()

void Sender::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 104 of file wifi-example-apps.cc.

References ns3::Socket::Bind(), ns3::Simulator::Cancel(), ns3::Application::GetNode(), ns3::Object::GetObject(), ns3::UdpSocketFactory::GetTypeId(), m_count, m_sendEvent, m_socket, NS_LOG_FUNCTION_NOARGS, ns3::Simulator::ScheduleNow(), and SendPacket().

Here is the call graph for this function:

◆ StopApplication()

void Sender::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 123 of file wifi-example-apps.cc.

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

Here is the call graph for this function:

Member Data Documentation

◆ m_count

uint32_t Sender::m_count {0}

private

Number of packets sent.

Definition at line 70 of file wifi-example-apps.h.

Referenced by SendPacket(), and StartApplication().

◆ m_destAddr

Ipv4Address Sender::m_destAddr

private

Destination address.

Definition at line 65 of file wifi-example-apps.h.

Referenced by GetTypeId(), and SendPacket().

◆ m_destPort

uint32_t Sender::m_destPort {0}

private

Destination port.

Definition at line 66 of file wifi-example-apps.h.

Referenced by GetTypeId(), and SendPacket().

◆ m_interval

Ptr<ConstantRandomVariable> Sender::m_interval

private

Rng for sending packets.

Definition at line 68 of file wifi-example-apps.h.

Referenced by Sender(), GetTypeId(), and SendPacket().

◆ m_nPackets

uint32_t Sender::m_nPackets {0}

private

Number of packets to send.

Definition at line 69 of file wifi-example-apps.h.

Referenced by GetTypeId(), and SendPacket().

◆ m_packetSize

uint32_t Sender::m_packetSize {0}

private

The packet size.

Definition at line 67 of file wifi-example-apps.h.

Referenced by GetTypeId(), and SendPacket().

◆ m_sendEvent

EventId Sender::m_sendEvent

private

Send packet event.

Definition at line 73 of file wifi-example-apps.h.

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

◆ m_socket

Ptr<Socket> Sender::m_socket

private

Sending socket.

Definition at line 72 of file wifi-example-apps.h.

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

◆ m_txTrace

TracedCallback<Ptr<const Packet> > Sender::m_txTrace

private

Tx TracedCallback.

Definition at line 76 of file wifi-example-apps.h.

Referenced by GetTypeId(), and SendPacket().

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

examples/stats/wifi-example-apps.h
examples/stats/wifi-example-apps.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Sender()

◆ ~Sender()

Member Function Documentation

◆ DoDispose()

◆ GetTypeId()

◆ SendPacket()

◆ StartApplication()

◆ StopApplication()

Member Data Documentation

◆ m_count

◆ m_destAddr

◆ m_destPort

◆ m_interval

◆ m_nPackets

◆ m_packetSize

◆ m_sendEvent

◆ m_socket

◆ m_txTrace