flow-probe.h

Go to the documentation of this file.

//
// Copyright (c) 2009 INESC Porto
//
// 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: Gustavo J. A. M. Carneiro  <gjc@inescporto.pt> <gjcarneiro@gmail.com>
//
 
#ifndef FLOW_PROBE_H
#define FLOW_PROBE_H
 
#include "ns3/flow-classifier.h"
#include "ns3/nstime.h"
#include "ns3/object.h"
 
#include <map>
#include <vector>
 
namespace ns3
{
 
class FlowMonitor;
 
class FlowProbe : public Object
{
  protected:
    FlowProbe(Ptr<FlowMonitor> flowMonitor);
    void DoDispose() override;
 
  public:
    ~FlowProbe() override;
 
    // Delete copy constructor and assignment operator to avoid misuse
    FlowProbe(const FlowProbe&) = delete;
    FlowProbe& operator=(const FlowProbe&) = delete;
 
    static TypeId GetTypeId();
 
    struct FlowStats
    {
        FlowStats()
            : delayFromFirstProbeSum(Seconds(0)),
              bytes(0),
              packets(0)
        {
        }
 
        std::vector<uint32_t> packetsDropped;
        std::vector<uint64_t> bytesDropped;
        Time delayFromFirstProbeSum;
        uint64_t bytes;
        uint32_t packets;
    };
 
    typedef std::map<FlowId, FlowStats> Stats;
 
    void AddPacketStats(FlowId flowId, uint32_t packetSize, Time delayFromFirstProbe);
    void AddPacketDropStats(FlowId flowId, uint32_t packetSize, uint32_t reasonCode);
 
    Stats GetStats() const;
 
    void SerializeToXmlStream(std::ostream& os, uint16_t indent, uint32_t index) const;
 
  protected:
    Ptr<FlowMonitor> m_flowMonitor; 
    Stats m_stats;                  
};
 
} // namespace ns3
 
#endif /* FLOW_PROBE_H */