/usr/include/ns3.27/ns3/ipv4-packet-probe.h is in libns3-dev 3.27+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 126 127 128 129 130 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2011 Bucknell University
*
* 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
*
* Authors: L. Felipe Perrone (perrone@bucknell.edu)
* Tiago G. Rodrigues (tgr002@bucknell.edu)
*
* Modified by: Mitch Watrous (watrous@u.washington.edu)
*/
#ifndef IPV4_PACKET_PROBE_H
#define IPV4_PACKET_PROBE_H
#include "ns3/object.h"
#include "ns3/callback.h"
#include "ns3/boolean.h"
#include "ns3/nstime.h"
#include "ns3/packet.h"
#include "ns3/ipv4.h"
#include "ns3/traced-value.h"
#include "ns3/simulator.h"
#include "ns3/probe.h"
namespace ns3 {
/**
* \ingroup ipv4
*
* This class is designed to probe an underlying ns3 TraceSource
* exporting a packet, an IPv4 object, and an interface. This probe
* exports a trace source "Output" with arguments of type Ptr<const Packet>,
* Ptr<Ipv4>, and uint32_t. The Output trace source emits a value
* when either the trace source emits a new value, or when SetValue ()
* is called.
*/
class Ipv4PacketProbe : public Probe
{
public:
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId ();
Ipv4PacketProbe ();
virtual ~Ipv4PacketProbe ();
/**
* \brief Set a probe value
*
* \param packet set the traced packet equal to this
* \param ipv4 set the IPv4 object for the traced packet equal to this
* \param interface set the IPv4 interface for the traced packet equal to this
*/
void SetValue (Ptr<const Packet> packet, Ptr<Ipv4> ipv4, uint32_t interface);
/**
* \brief Set a probe value by its name in the Config system
*
* \param path config path to access the probe
* \param packet set the traced packet equal to this
* \param ipv4 set the IPv4 object for the traced packet equal to this
* \param interface set the IPv4 interface for the traced packet equal to this
*/
static void SetValueByPath (std::string path, Ptr<const Packet> packet, Ptr<Ipv4> ipv4, uint32_t interface);
/**
* \brief connect to a trace source attribute provided by a given object
*
* \param traceSource the name of the attribute TraceSource to connect to
* \param obj ns3::Object to connect to
* \return true if the trace source was successfully connected
*/
virtual bool ConnectByObject (std::string traceSource, Ptr<Object> obj);
/**
* \brief connect to a trace source provided by a config path
*
* \param path Config path to bind to
*
* Note, if an invalid path is provided, the probe will not be connected
* to anything.
*/
virtual void ConnectByPath (std::string path);
private:
/**
* \brief Method to connect to an underlying ns3::TraceSource with
* arguments of type Ptr<const Packet>, Ptr<Ipv4>, and uint32_t
*
* \param packet the traced packet
* \param ipv4 the IPv4 object for the traced packet
* \param interface the IPv4 interface for the traced packet
*/
void TraceSink (Ptr<const Packet> packet, Ptr<Ipv4> ipv4, uint32_t interface);
/// Traced Callback: the packet, the Ipv4 object and the interface.
ns3::TracedCallback<Ptr<const Packet>, Ptr<Ipv4>, uint32_t> m_output;
/// Traced Callback: the previous packet's size and the actual packet's size.
ns3::TracedCallback<uint32_t, uint32_t> m_outputBytes;
/// The traced packet.
Ptr<const Packet> m_packet;
/// The IPv4 object for the traced packet.
Ptr<Ipv4> m_ipv4;
/// The IPv4 interface for the traced packet.
uint32_t m_interface;
/// The size of the traced packet.
uint32_t m_packetSizeOld;
};
} // namespace ns3
#endif // IPV4_PACKET_PROBE_H
|