A Discrete-Event Network Simulator
API
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
Sender Class Reference

Sender application. More...

#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
 
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 ()
 Constructor. More...
 
 ~Object () override
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose ()
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one. More...
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object. More...
 
template<>
Ptr< Object > GetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< Object > GetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized () const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount () const
 Get the reference count of the object. More...
 
SimpleRefCount & operator= (const SimpleRefCount &o[[maybe_unused]])
 Assignment operator. More...
 
void Ref () const
 Increment the reference count. More...
 
void Unref () const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Application
static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Protected Member Functions

void DoDispose () override
 Destructor implementation. More...
 
- Protected Member Functions inherited from ns3::Application
void DoDispose () override
 Destructor implementation. More...
 
void DoInitialize () override
 Initialize() implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed. More...
 

Private Member Functions

void SendPacket ()
 Send a packet. More...
 
void StartApplication () override
 Application specific startup code. More...
 
void StopApplication () override
 Application specific shutdown code. More...
 

Private Attributes

uint32_t m_count {0}
 Number of packets sent. More...
 
Ipv4Address m_destAddr
 Destination address. More...
 
uint32_t m_destPort {0}
 Destination port. More...
 
Ptr< ConstantRandomVariable > m_interval
 Rng for sending packets. More...
 
uint32_t m_nPackets {0}
 Number of packets to send. More...
 
uint32_t m_packetSize {0}
 The packet size. More...
 
EventId m_sendEvent
 Send packet event. More...
 
Ptr< Socket > m_socket
 Sending socket. More...
 
TracedCallback< Ptr< const Packet > > m_txTrace
 Tx TracedCallback. More...
 

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. More...
 
typedef void(* StateTransitionCallback) (const std::string &oldState, const std::string &newState)
 Common signature used by callbacks to application's state transition trace source. More...
 
- Protected Attributes inherited from ns3::Application
Ptr< Node > m_node
 The node that this application is installed on. More...
 
EventId m_startEvent
 The event that will fire at m_startTime to start the application. More...
 
Time m_startTime
 The simulation time that the application will start. More...
 
EventId m_stopEvent
 The event that will fire at m_stopTime to end the application. More...
 
Time m_stopTime
 The simulation time that the application will end. More...
 
- Related Functions inherited from ns3::ObjectBase
static TypeId GetObjectIid ()
 Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...
 

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 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 ( void  )
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(), and NS_LOG_FUNCTION_NOARGS.

+ Here is the call graph for this function:

◆ GetTypeId()

TypeId Sender::GetTypeId ( void  )
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::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::Packet::AddByteTag(), ns3::Simulator::Now(), NS_LOG_INFO, ns3::Simulator::Schedule(), ns3::Seconds(), and ns3::TimestampTag::SetTimestamp().

Referenced by StartApplication().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ StartApplication()

void Sender::StartApplication ( void  )
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::Simulator::Cancel(), ns3::UdpSocketFactory::GetTypeId(), NS_LOG_FUNCTION_NOARGS, ns3::Simulator::ScheduleNow(), and SendPacket().

+ Here is the call graph for this function:

◆ StopApplication()

void Sender::StopApplication ( void  )
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(), 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.

◆ m_destAddr

Ipv4Address Sender::m_destAddr
private

Destination address.

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

Referenced by GetTypeId().

◆ m_destPort

uint32_t Sender::m_destPort {0}
private

Destination port.

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

Referenced by GetTypeId().

◆ m_interval

Ptr<ConstantRandomVariable> Sender::m_interval
private

Rng for sending packets.

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

Referenced by GetTypeId().

◆ 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().

◆ 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().

◆ m_sendEvent

EventId Sender::m_sendEvent
private

Send packet event.

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

◆ m_socket

Ptr<Socket> Sender::m_socket
private

Sending socket.

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

◆ 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().

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