/usr/include/ns3.26/ns3/ipv4-flow-probe.h is in libns3-dev 3.26+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 | /* -*- 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;
/// \ingroup flow-monitor
/// \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:
/// \brief Constructor
/// \param monitor the FlowMonitor this probe is associated with
/// \param classifier the Ipv4FlowClassifier this probe is associated with
/// \param node the Node this probe is associated with
Ipv4FlowProbe (Ptr<FlowMonitor> monitor, Ptr<Ipv4FlowClassifier> classifier, Ptr<Node> node);
virtual ~Ipv4FlowProbe ();
/// Register this type.
/// \return The TypeId.
static TypeId GetTypeId (void);
/// \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,
/// Packet dropped due to queue overflow. Note: only works for
/// NetDevices that provide a TxQueue attribute of type Queue
/// with a Drop trace source. It currently works with Csma and
/// PointToPoint devices, but not with WiFi or WiMax.
DROP_QUEUE,
/// Packet dropped by the queue disc
DROP_QUEUE_DISC,
DROP_INTERFACE_DOWN, /**< Interface is down so can not send packet */
DROP_ROUTE_ERROR, /**< Route error */
DROP_FRAGMENT_TIMEOUT, /**< Fragment timeout exceeded */
DROP_INVALID_REASON, /**< Fallback reason (no known reason) */
};
protected:
virtual void DoDispose (void);
private:
/// Log a packet being sent
/// \param ipHeader IP header
/// \param ipPayload IP payload
/// \param interface outgoing interface
void SendOutgoingLogger (const Ipv4Header &ipHeader, Ptr<const Packet> ipPayload, uint32_t interface);
/// Log a packet being forwarded
/// \param ipHeader IP header
/// \param ipPayload IP payload
/// \param interface incoming interface
void ForwardLogger (const Ipv4Header &ipHeader, Ptr<const Packet> ipPayload, uint32_t interface);
/// Log a packet being received by the destination
/// \param ipHeader IP header
/// \param ipPayload IP payload
/// \param interface incoming interface
void ForwardUpLogger (const Ipv4Header &ipHeader, Ptr<const Packet> ipPayload, uint32_t interface);
/// Log a packet being dropped
/// \param ipHeader IP header
/// \param ipPayload IP payload
/// \param reason drop reason
/// \param ipv4 pointer to the IP object dropping the packet
/// \param ifIndex interface index
void DropLogger (const Ipv4Header &ipHeader, Ptr<const Packet> ipPayload,
Ipv4L3Protocol::DropReason reason, Ptr<Ipv4> ipv4, uint32_t ifIndex);
/// Log a packet being dropped by a queue
/// \param ipPayload IP payload
void QueueDropLogger (Ptr<const Packet> ipPayload);
/// Log a packet being dropped by a queue disc
/// \param item queue item
void QueueDiscDropLogger (Ptr<const QueueItem> item);
Ptr<Ipv4FlowClassifier> m_classifier; //!< the Ipv4FlowClassifier this probe is associated with
Ptr<Ipv4L3Protocol> m_ipv4; //!< the Ipv4L3Protocol this probe is bound to
};
} // namespace ns3
#endif /* IPV4_FLOW_PROBE_H */
|