A Discrete-Event Network Simulator
API
packet-probe.h
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2011 Bucknell University
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation;
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 *
18 * Authors: L. Felipe Perrone (perrone@bucknell.edu)
19 * Tiago G. Rodrigues (tgr002@bucknell.edu)
20 *
21 * Modified by: Mitch Watrous (watrous@u.washington.edu)
22 */
23
24#ifndef PACKET_PROBE_H
25#define PACKET_PROBE_H
26
27#include "ns3/object.h"
28#include "ns3/callback.h"
29#include "ns3/boolean.h"
30#include "ns3/nstime.h"
31#include "ns3/packet.h"
32#include "ns3/traced-value.h"
33#include "ns3/simulator.h"
34#include "ns3/probe.h"
35
36namespace ns3 {
37
47class PacketProbe : public Probe
48{
49public:
54 static TypeId GetTypeId ();
55 PacketProbe ();
56 virtual ~PacketProbe ();
57
63 void SetValue (Ptr<const Packet> packet);
64
71 static void SetValueByPath (std::string path, Ptr<const Packet> packet);
72
80 virtual bool ConnectByObject (std::string traceSource, Ptr<Object> obj);
81
90 virtual void ConnectByPath (std::string path);
91
92private:
99 void TraceSink (Ptr<const Packet> packet);
100
105
108
111};
112
113
114} // namespace ns3
115
116#endif // PACKET_PROBE_H
This class is designed to probe an underlying ns3 TraceSource exporting a packet.
Definition: packet-probe.h:48
virtual bool ConnectByObject(std::string traceSource, Ptr< Object > obj)
connect to a trace source attribute provided by a given object
Definition: packet-probe.cc:89
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:38
void TraceSink(Ptr< const Packet > packet)
Method to connect to an underlying ns3::TraceSource with arguments of type Ptr<const Packet>
virtual ~PacketProbe()
Definition: packet-probe.cc:62
virtual void ConnectByPath(std::string path)
connect to a trace source provided by a config path
Definition: packet-probe.cc:98
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
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:40
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.