A Discrete-Event Network Simulator
API
Receiver Class Reference

#include "wifi-example-apps.h"

+ Inheritance diagram for Receiver:
+ Collaboration diagram for Receiver:

Public Member Functions

 Receiver ()
 
virtual ~Receiver ()
 
void SetCounter (Ptr< CounterCalculator<> > calc)
 
void SetDelayTracker (Ptr< TimeMinMaxAvgTotalCalculator > delay)
 
- Public Member Functions inherited from ns3::Application
 Application ()
 
virtual ~Application ()
 
Ptr< NodeGetNode () 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...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<>
Ptr< ObjectGetObject () 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< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) 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 (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= ([[maybe_unused]] const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) 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 erros. 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 (void)
 
- Static Public Member Functions inherited from ns3::Application
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Protected Member Functions

virtual void DoDispose (void)
 Destructor implementation. More...
 
- Protected Member Functions inherited from ns3::Application
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void NotifyNewAggregate (void)
 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 (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Private Member Functions

void Receive (Ptr< Socket > socket)
 
virtual void StartApplication (void)
 Application specific startup code. More...
 
virtual void StopApplication (void)
 Application specific shutdown code. More...
 

Private Attributes

Ptr< CounterCalculator<> > m_calc
 
Ptr< TimeMinMaxAvgTotalCalculatorm_delay
 
uint32_t m_port
 
Ptr< Socketm_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. 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< Nodem_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...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ Receiver()

Receiver::Receiver ( )

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

References m_socket, and NS_LOG_FUNCTION_NOARGS.

◆ ~Receiver()

Receiver::~Receiver ( )
virtual

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

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ DoDispose()

void Receiver::DoDispose ( void  )
protectedvirtual

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

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

References m_socket, and NS_LOG_FUNCTION_NOARGS.

◆ GetTypeId()

TypeId Receiver::GetTypeId ( void  )
static

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

References m_port, ns3::MakeUintegerAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ Receive()

void Receiver::Receive ( Ptr< Socket socket)
private

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

References ns3::Packet::FindFirstMatchingByteTag(), ns3::Packet::GetSize(), TimestampTag::GetTimestamp(), m_calc, m_delay, ns3::Now(), NS_LOG_INFO, ns3::Socket::RecvFrom(), and ns3::TimeMinMaxAvgTotalCalculator::Update().

Referenced by StartApplication().

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

◆ SetCounter()

void Receiver::SetCounter ( Ptr< CounterCalculator<> >  calc)

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

References m_calc.

◆ SetDelayTracker()

void Receiver::SetDelayTracker ( Ptr< TimeMinMaxAvgTotalCalculator delay)

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

References m_delay.

◆ StartApplication()

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

References ns3::Socket::Bind(), ns3::Application::GetNode(), ns3::Object::GetObject(), m_port, m_socket, ns3::MakeCallback(), NS_LOG_FUNCTION_NOARGS, Receive(), and ns3::Socket::SetRecvCallback().

+ Here is the call graph for this function:

◆ StopApplication()

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

References m_socket, ns3::MakeNullCallback(), NS_LOG_FUNCTION_NOARGS, and ns3::Socket::SetRecvCallback().

+ Here is the call graph for this function:

Member Data Documentation

◆ m_calc

Ptr<CounterCalculator<> > Receiver::m_calc
private

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

Referenced by Receive(), and SetCounter().

◆ m_delay

Ptr<TimeMinMaxAvgTotalCalculator> Receiver::m_delay
private

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

Referenced by Receive(), and SetDelayTracker().

◆ m_port

uint32_t Receiver::m_port
private

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

Referenced by GetTypeId(), and StartApplication().

◆ m_socket

Ptr<Socket> Receiver::m_socket
private

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

Referenced by Receiver(), DoDispose(), StartApplication(), and StopApplication().


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