A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
Receiver Class Reference

Receiver application. More...

#include "wifi-example-apps.h"

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

Public Member Functions

 Receiver ()
 
 ~Receiver () override
 
void SetCounter (Ptr< CounterCalculator<> > calc)
 Set the counter calculator for received packets.
 
void SetDelayTracker (Ptr< TimeMinMaxAvgTotalCalculator > delay)
 Set the delay tracker for received packets.
 
- 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< NodeGetNode () 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< ObjectGetObject () 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< ObjectGetObject (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.
 
SimpleRefCountoperator= (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 Receive (Ptr< Socket > socket)
 Receive a packet.
 
void StartApplication () override
 Application specific startup code.
 
void StopApplication () override
 Application specific shutdown code.
 

Private Attributes

Ptr< CounterCalculator<> > m_calc
 Counter of the number of received packets.
 
Ptr< TimeMinMaxAvgTotalCalculatorm_delay
 Delay calculator.
 
uint32_t m_port {0}
 Listening port.
 
Ptr< Socketm_socket
 Receiving 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 Attributes inherited from ns3::Application
Ptr< Nodem_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.
 

Detailed Description

Receiver application.

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

Constructor & Destructor Documentation

◆ Receiver()

Receiver::Receiver ( )

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

References NS_LOG_FUNCTION_NOARGS.

◆ ~Receiver()

Receiver::~Receiver ( )
override

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

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ DoDispose()

void Receiver::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 184 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 Receiver::GetTypeId ( )
static

Get the type ID.

Returns
The object TypeId.

Definition at line 160 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

Receive a packet.

Parameters
socketThe receiving socket.

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

References ns3::InetSocketAddress::ConvertFrom(), ns3::InetSocketAddress::GetIpv4(), ns3::TimestampTag::GetTimestamp(), ns3::InetSocketAddress::IsMatchingType(), m_calc, m_delay, ns3::Simulator::Now(), NS_LOG_INFO, 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)

Set the counter calculator for received packets.

Parameters
calcThe CounterCalculator.

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

References m_calc.

◆ SetDelayTracker()

void Receiver::SetDelayTracker ( Ptr< TimeMinMaxAvgTotalCalculator delay)

Set the delay tracker for received packets.

Parameters
delayThe Delay calculator.

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

References m_delay.

◆ StartApplication()

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

References ns3::Socket::Bind(), ns3::Ipv4Address::GetAny(), ns3::Application::GetNode(), ns3::Object::GetObject(), ns3::UdpSocketFactory::GetTypeId(), 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 ( )
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 211 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

Counter of the number of received packets.

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

Referenced by Receive(), and SetCounter().

◆ m_delay

Ptr<TimeMinMaxAvgTotalCalculator> Receiver::m_delay
private

Delay calculator.

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

Referenced by Receive(), and SetDelayTracker().

◆ m_port

uint32_t Receiver::m_port {0}
private

Listening port.

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

Referenced by GetTypeId(), and StartApplication().

◆ m_socket

Ptr<Socket> Receiver::m_socket
private

Receiving socket.

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

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


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