onoff-application.h

Go to the documentation of this file.

//
// Copyright (c) 2006 Georgia Tech Research Corporation
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License version 2 as
// published by the Free Software Foundation;
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// Author: George F. Riley<riley@ece.gatech.edu>
//
 
// ns3 - On/Off Data Source Application class
// George F. Riley, Georgia Tech, Spring 2007
// Adapted from ApplicationOnOff in GTNetS.
 
#ifndef ONOFF_APPLICATION_H
#define ONOFF_APPLICATION_H
 
#include "seq-ts-size-header.h"
 
#include "ns3/address.h"
#include "ns3/application.h"
#include "ns3/data-rate.h"
#include "ns3/event-id.h"
#include "ns3/ptr.h"
#include "ns3/traced-callback.h"
 
namespace ns3
{
 
class Address;
class RandomVariableStream;
class Socket;
 
class OnOffApplication : public Application
{
  public:
    static TypeId GetTypeId();
 
    OnOffApplication();
 
    ~OnOffApplication() override;
 
    void SetMaxBytes(uint64_t maxBytes);
 
    Ptr<Socket> GetSocket() const;
 
    int64_t AssignStreams(int64_t stream);
 
  protected:
    void DoDispose() override;
 
  private:
    // inherited from Application base class.
    void StartApplication() override; // Called at time specified by Start
    void StopApplication() override;  // Called at time specified by Stop
 
    // helpers
    void CancelEvents();
 
    // Event handlers
    void StartSending();
    void StopSending();
    void SendPacket();
 
    Ptr<Socket> m_socket;                
    Address m_peer;                      
    Address m_local;                     
    bool m_connected;                    
    Ptr<RandomVariableStream> m_onTime;  
    Ptr<RandomVariableStream> m_offTime; 
    DataRate m_cbrRate;                  
    DataRate m_cbrRateFailSafe;          
    uint32_t m_pktSize;                  
    uint32_t m_residualBits;             
    Time m_lastStartTime;                
    uint64_t m_maxBytes;                 
    uint64_t m_totBytes;                 
    EventId m_startStopEvent;            
    EventId m_sendEvent;                 
    TypeId m_tid;                        
    uint32_t m_seq{0};                   
    Ptr<Packet> m_unsentPacket;          
    bool m_enableSeqTsSizeHeader{false}; 
 
    TracedCallback<Ptr<const Packet>> m_txTrace;
 
    TracedCallback<Ptr<const Packet>, const Address&, const Address&> m_txTraceWithAddresses;
 
    TracedCallback<Ptr<const Packet>, const Address&, const Address&, const SeqTsSizeHeader&>
        m_txTraceWithSeqTsSize;
 
  private:
    void ScheduleNextTx();
    void ScheduleStartEvent();
    void ScheduleStopEvent();
    void ConnectionSucceeded(Ptr<Socket> socket);
    void ConnectionFailed(Ptr<Socket> socket);
};
 
} // namespace ns3
 
#endif /* ONOFF_APPLICATION_H */