/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */

 //

 // 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 __IPV4_FLOW_PROBE_H__

 #define __IPV4_FLOW_PROBE_H__

 #include "ns3/flow-probe.h"

 #include "ns3/ipv4-flow-classifier.h"

 #include "ns3/ipv4-l3-protocol.h"

 namespace ns3 {

 class FlowMonitor;

 class Node;

 /// \brief Class that monitors flows at the IPv4 layer of a Node

 ///

 /// For each node in the simulation, one instance of the class

 /// Ipv4FlowProbe is created to monitor that node.  Ipv4FlowProbe

 /// accomplishes this by connecting callbacks to trace sources in the

 /// Ipv4L3Protocol interface of the node.

 class Ipv4FlowProbe : public FlowProbe

 {

 public:

   Ipv4FlowProbe (Ptr<FlowMonitor> monitor, Ptr<Ipv4FlowClassifier> classifier, Ptr<Node> node);

   virtual ~Ipv4FlowProbe ();

   /// \brief enumeration of possible reasons why a packet may be dropped

   enum DropReason 

     {

       /// Packet dropped due to missing route to the destination

       DROP_NO_ROUTE = 0,

       /// Packet dropped due to TTL decremented to zero during IPv4 forwarding

       DROP_TTL_EXPIRE,      

       /// Packet dropped due to invalid checksum in the IPv4 header

       DROP_BAD_CHECKSUM,

       // DROP_QUEUE, // TODO: this is not easy to do

       DROP_INVALID_REASON,

     };

 private:

   void SendOutgoingLogger (const Ipv4Header &ipHeader, Ptr<const Packet> ipPayload, uint32_t interface);

   void ForwardLogger (const Ipv4Header &ipHeader, Ptr<const Packet> ipPayload, uint32_t interface);

   void ForwardUpLogger (const Ipv4Header &ipHeader, Ptr<const Packet> ipPayload, uint32_t interface);

   void DropLogger (const Ipv4Header &ipHeader, Ptr<const Packet> ipPayload,

                    Ipv4L3Protocol::DropReason reason, uint32_t ifIndex);

   Ptr<Ipv4FlowClassifier> m_classifier;

 };

 } // namespace ns3

 #endif