wifi-example-apps.h

Go to the documentation of this file.

/*
 * SPDX-License-Identifier: GPL-2.0-only
 *
 * Authors: Joe Kopena <tjkopena@cs.drexel.edu>
 *
 * These applications are used in the WiFi Distance Test experiment,
 * described and implemented in test02.cc.  That file should be in the
 * same place as this file.  The applications have two very simple
 * jobs, they just generate and receive packets.  We could use the
 * standard Application classes included in the NS-3 distribution.
 * These have been written just to change the behavior a little, and
 * provide more examples.
 *
 */
 
#ifndef WIFI_EXAMPLE_APPS_H
#define WIFI_EXAMPLE_APPS_H
 
#include "ns3/application.h"
#include "ns3/core-module.h"
#include "ns3/network-module.h"
#include "ns3/stats-module.h"
 
using namespace ns3;
 
// ==============================================
// SENDER
// ==============================================
 
/**
 * Sender application.
 */
class Sender : public Application
{
  public:
    /**
     * @brief Get the type ID.
     * @return The object TypeId.
     */
    static TypeId GetTypeId();
 
    Sender();
    ~Sender() override;
 
  protected:
    void DoDispose() override;
 
  private:
    void StartApplication() override;
    void StopApplication() override;
 
    /**
     * Send a packet.
     */
    void SendPacket();
 
    Ipv4Address m_destAddr;                 //!< Destination address
    uint32_t m_destPort{0};                 //!< Destination port
    uint32_t m_packetSize{0};               //!< The packet size
    Ptr<ConstantRandomVariable> m_interval; //!< Rng for sending packets
    uint32_t m_nPackets{0};                 //!< Number of packets to send
    uint32_t m_count{0};                    //!< Number of packets sent
 
    Ptr<Socket> m_socket; //!< Sending socket
    EventId m_sendEvent;  //!< Send packet event
 
    /// Tx TracedCallback
    TracedCallback<Ptr<const Packet>> m_txTrace;
};
 
// ==============================================
// RECEIVER
// ==============================================
 
/**
 * Receiver application.
 */
class Receiver : public Application
{
  public:
    /**
     * @brief Get the type ID.
     * @return The object TypeId.
     */
    static TypeId GetTypeId();
 
    Receiver();
    ~Receiver() override;
 
    /**
     * Set the counter calculator for received packets.
     * @param calc The CounterCalculator.
     */
    void SetCounter(Ptr<CounterCalculator<>> calc);
 
    /**
     * Set the delay tracker for received packets.
     * @param delay The Delay calculator.
     */
    void SetDelayTracker(Ptr<TimeMinMaxAvgTotalCalculator> delay);
 
  protected:
    void DoDispose() override;
 
  private:
    void StartApplication() override;
    void StopApplication() override;
 
    /**
     * Receive a packet.
     * @param socket The receiving socket.
     */
    void Receive(Ptr<Socket> socket);
 
    Ptr<Socket> m_socket; //!< Receiving socket
    uint32_t m_port{0};   //!< Listening port
 
    Ptr<CounterCalculator<>> m_calc;           //!< Counter of the number of received packets
    Ptr<TimeMinMaxAvgTotalCalculator> m_delay; //!< Delay calculator
};
 
#endif // WIFI_EXAMPLE_APPS_H