A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
packet-probe.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2011 Bucknell University
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation;
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 *
17 * Authors: L. Felipe Perrone (perrone@bucknell.edu)
18 * Tiago G. Rodrigues (tgr002@bucknell.edu)
19 *
20 * Modified by: Mitch Watrous (watrous@u.washington.edu)
21 */
22
23#ifndef PACKET_PROBE_H
24#define PACKET_PROBE_H
25
26#include "ns3/boolean.h"
27#include "ns3/callback.h"
28#include "ns3/nstime.h"
29#include "ns3/object.h"
30#include "ns3/packet.h"
31#include "ns3/probe.h"
32#include "ns3/simulator.h"
33#include "ns3/traced-value.h"
34
35namespace ns3
36{
37
47class PacketProbe : public Probe
48{
49 public:
54 static TypeId GetTypeId();
56 ~PacketProbe() override;
57
63 void SetValue(Ptr<const Packet> packet);
64
71 static void SetValueByPath(std::string path, Ptr<const Packet> packet);
72
80 bool ConnectByObject(std::string traceSource, Ptr<Object> obj) override;
81
90 void ConnectByPath(std::string path) override;
91
92 private:
99 void TraceSink(Ptr<const Packet> packet);
100
105
108
111};
112
113} // namespace ns3
114
115#endif // PACKET_PROBE_H
This class is designed to probe an underlying ns3 TraceSource exporting a packet.
Definition: packet-probe.h:48
~PacketProbe() override
Definition: packet-probe.cc:62
TracedCallback< uint32_t, uint32_t > m_outputBytes
Traced callback: size of previous packet receive, size of actual packet received.
Definition: packet-probe.h:104
static TypeId GetTypeId()
Get the type ID.
Definition: packet-probe.cc:39
void TraceSink(Ptr< const Packet > packet)
Method to connect to an underlying ns3::TraceSource with arguments of type Ptr<const Packet>
bool ConnectByObject(std::string traceSource, Ptr< Object > obj) override
connect to a trace source attribute provided by a given object
Definition: packet-probe.cc:89
static void SetValueByPath(std::string path, Ptr< const Packet > packet)
Set a probe value by its name in the Config system.
Definition: packet-probe.cc:80
uint32_t m_packetSizeOld
The size of the traced packet.
Definition: packet-probe.h:110
void ConnectByPath(std::string path) override
connect to a trace source provided by a config path
TracedCallback< Ptr< const Packet > > m_output
Traced callback: packet received.
Definition: packet-probe.h:102
void SetValue(Ptr< const Packet > packet)
Set a probe value.
Definition: packet-probe.cc:68
Ptr< const Packet > m_packet
The traced packet.
Definition: packet-probe.h:107
Base class for probes.
Definition: probe.h:41
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:77
Forward calls to a chain of Callback.
a unique identifier for an interface.
Definition: type-id.h:59
Every class exported by the ns3 library is enclosed in the ns3 namespace.