traffic-generator.h

// Copyright (c) 2010 Georgia Institute of Technology
// Copyright (c) 2022 CTTC
// Copyright (c) 2023 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
 
#ifndef TRAFFIC_GENERATOR_H
#define TRAFFIC_GENERATOR_H
 
#include "ns3/address.h"
#include "ns3/application.h"
#include "ns3/event-id.h"
#include "ns3/ptr.h"
#include "ns3/traced-callback.h"
 
namespace ns3
{
 
class Address;
class Socket;
 
class TrafficGenerator : public Application
{
  public:
    static TypeId GetTypeId();
 
    TrafficGenerator();
 
    ~TrafficGenerator() override;
 
    uint64_t GetTotalBytes() const;
 
    uint64_t GetTotalPackets() const;
 
    bool SendPacketBurst();
 
    Ptr<Socket> GetSocket() const;
 
    void SetPacketSize(uint32_t packetSize);
    void SetRemote(Address remote);
    void SetProtocol(TypeId protocol);
 
    typedef TracedCallback<Ptr<const Packet>> TxTracedCallback;
    TxTracedCallback m_txTrace;
 
    int64_t AssignStreams(int64_t stream) override;
 
  protected:
    void DoDispose() override;
    void DoInitialize() override;
    /*
     * @brief Used by child classes to configure the burst size in the number
     * of bytes when GenerateNextPucketBurstSize is called
     */
    void SetPacketBurstSizeInBytes(uint32_t burstSize);
    /*
     * @brief Used by child classes to configure the burst size in the number
     * of packets when GenerateNextPucketBurstSize is called
     */
    void SetPacketBurstSizeInPackets(uint32_t burstSize);
    /*
     * @brief Returns the latest generated packet burst size in the number
     * of bytes
     */
    uint32_t GetPacketBurstSizeInBytes() const;
    /*
     * @brief Returns the latest generated packet burst size in the number
     * of bytes
     */
    uint32_t GetPacketBurstSizeInPackets() const;
    /*
     * @brief Called at the time specified by the Stop.
     * Notice that we want to allow that child classes can call stop of this class,
     * which is why we change its default access level from private to protected.
     */
    void StopApplication() override; // Called at time specified by Stop
    /*
     * @return Traffic generator ID
     */
    uint16_t GetTgId() const;
 
    /*
     * @brief Returns peer address
     * @return the peer address
     */
    Address GetPeer() const;
 
  private:
    // inherited from Application base class.
    void StartApplication() override; // Called at time specified by Start
    void SendNextPacket();
    void ConnectionSucceeded(Ptr<Socket> socket);
    void ConnectionFailed(Ptr<Socket> socket);
    void CloseSucceeded(Ptr<Socket> socket);
    void CloseFailed(Ptr<Socket> socket);
    void SendNextPacketIfConnected(Ptr<Socket>, uint32_t);
    virtual void PacketBurstSent();
    virtual void GenerateNextPacketBurstSize();
    virtual uint32_t GetNextPacketSize() const = 0;
    virtual Time GetNextPacketTime() const;
 
    Ptr<Socket> m_socket;                   
    Address m_peer;                         
    bool m_connected{false};                
    uint32_t m_currentBurstTotBytes{0};     
    TypeId m_tid;                           
    uint32_t m_currentBurstTotPackets{0};   
    uint64_t m_totBytes{0};                 
    uint64_t m_totPackets{0};               
    bool m_stopped{false};                  
    uint32_t m_packetBurstSizeInBytes{0};   
    uint32_t m_packetBurstSizeInPackets{0}; 
    EventId m_eventIdSendNextPacket; 
    bool m_waitForNextPacketBurst{
        false}; 
 
    static uint16_t m_tgIdCounter; 
    uint16_t m_tgId{0};            
    uint16_t m_packetId{
        0}; 
};
 
} // namespace ns3
 
#endif /* TRAFFIC_GENERATOR_H */