src/applications/model/application-packet-probe.cc
author Mohit Goyal <mohit.bits2011@gmail.com>
Fri, 27 Mar 2015 07:17:37 -0700
changeset 11240 5b6a7efcf062
parent 11086 65914b1ed5b3
child 11606 98fa74311b21
permissions -rw-r--r--
SetGroupName for applications module
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10118
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     1
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     2
/*
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     3
 * Copyright (c) 2011 Bucknell University
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     4
 *
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     5
 * This program is free software; you can redistribute it and/or modify
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     6
 * it under the terms of the GNU General Public License version 2 as
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     7
 * published by the Free Software Foundation;
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     8
 *
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     9
 * This program is distributed in the hope that it will be useful,
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    12
 * GNU General Public License for more details.
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    13
 *
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    14
 * You should have received a copy of the GNU General Public License
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    15
 * along with this program; if not, write to the Free Software
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    16
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    17
 *
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    18
 * Authors: L. Felipe Perrone (perrone@bucknell.edu)
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    19
 *          Tiago G. Rodrigues (tgr002@bucknell.edu)
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    20
 *
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    21
 * Modified by: Mitch Watrous (watrous@u.washington.edu)
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    22
 */
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    23
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    24
#include "ns3/application-packet-probe.h"
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    25
#include "ns3/object.h"
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    26
#include "ns3/log.h"
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    27
#include "ns3/names.h"
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    28
#include "ns3/config.h"
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    29
#include "ns3/trace-source-accessor.h"
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    30
10968
2d29fee2b7b8 [Bug 1551] Redux: NS_LOG_COMPONENT_DEFINE inside or outside of ns3 namespace?
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 10652
diff changeset
    31
namespace ns3 {
10118
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    32
10968
2d29fee2b7b8 [Bug 1551] Redux: NS_LOG_COMPONENT_DEFINE inside or outside of ns3 namespace?
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 10652
diff changeset
    33
NS_LOG_COMPONENT_DEFINE ("ApplicationPacketProbe");
10118
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    34
10652
dc18deba4502 [doxygen] Revert r10410, r10411, r10412
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 10410
diff changeset
    35
NS_OBJECT_ENSURE_REGISTERED (ApplicationPacketProbe);
10118
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    36
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    37
TypeId
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    38
ApplicationPacketProbe::GetTypeId ()
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    39
{
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    40
  static TypeId tid = TypeId ("ns3::ApplicationPacketProbe")
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    41
    .SetParent<Probe> ()
11240
5b6a7efcf062 SetGroupName for applications module
Mohit Goyal <mohit.bits2011@gmail.com>
parents: 11086
diff changeset
    42
    .SetGroupName("Applications")
10118
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    43
    .AddConstructor<ApplicationPacketProbe> ()
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    44
    .AddTraceSource ( "Output",
11086
65914b1ed5b3 TracedCallback function signatures, the rest.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 10968
diff changeset
    45
                      "The packet plus its socket address that serve "
65914b1ed5b3 TracedCallback function signatures, the rest.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 10968
diff changeset
    46
                      "as the output for this probe",
65914b1ed5b3 TracedCallback function signatures, the rest.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 10968
diff changeset
    47
                      MakeTraceSourceAccessor (&ApplicationPacketProbe::m_output),
65914b1ed5b3 TracedCallback function signatures, the rest.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 10968
diff changeset
    48
                      "ns3::Packet::PacketAddressTracedCallback")
10118
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    49
    .AddTraceSource ( "OutputBytes",
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    50
                      "The number of bytes in the packet",
11086
65914b1ed5b3 TracedCallback function signatures, the rest.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 10968
diff changeset
    51
                      MakeTraceSourceAccessor (&ApplicationPacketProbe::m_outputBytes),
65914b1ed5b3 TracedCallback function signatures, the rest.
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 10968
diff changeset
    52
                      "ns3::Packet::PacketSizeTracedCallback")
10118
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    53
  ;
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    54
  return tid;
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    55
}
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    56
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    57
ApplicationPacketProbe::ApplicationPacketProbe ()
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    58
{
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    59
  NS_LOG_FUNCTION (this);
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    60
  m_packet = 0;
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    61
}
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    62
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    63
ApplicationPacketProbe::~ApplicationPacketProbe ()
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    64
{
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    65
  NS_LOG_FUNCTION (this);
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    66
}
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    67
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    68
void
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    69
ApplicationPacketProbe::SetValue (Ptr<const Packet> packet, const Address& address)
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    70
{
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    71
  NS_LOG_FUNCTION (this << packet << address);
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    72
  m_packet  = packet;
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    73
  m_address = address;
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    74
  m_output (packet, address);
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    75
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    76
  uint32_t packetSizeNew = packet->GetSize ();
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    77
  m_outputBytes (m_packetSizeOld, packetSizeNew);
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    78
  m_packetSizeOld = packetSizeNew;
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    79
}
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    80
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    81
void
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    82
ApplicationPacketProbe::SetValueByPath (std::string path, Ptr<const Packet> packet, const Address& address)
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    83
{
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    84
  NS_LOG_FUNCTION (path << packet << address);
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    85
  Ptr<ApplicationPacketProbe> probe = Names::Find<ApplicationPacketProbe> (path);
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    86
  NS_ASSERT_MSG (probe, "Error:  Can't find probe for path " << path);
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    87
  probe->SetValue (packet, address);
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    88
}
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    89
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    90
bool
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    91
ApplicationPacketProbe::ConnectByObject (std::string traceSource, Ptr<Object> obj)
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    92
{
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    93
  NS_LOG_FUNCTION (this << traceSource << obj);
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    94
  NS_LOG_DEBUG ("Name of probe (if any) in names database: " << Names::FindPath (obj));
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    95
  bool connected = obj->TraceConnectWithoutContext (traceSource, MakeCallback (&ns3::ApplicationPacketProbe::TraceSink, this));
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    96
  return connected;
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    97
}
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    98
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    99
void
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   100
ApplicationPacketProbe::ConnectByPath (std::string path)
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   101
{
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   102
  NS_LOG_FUNCTION (this << path);
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   103
  NS_LOG_DEBUG ("Name of probe to search for in config database: " << path);
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   104
  Config::ConnectWithoutContext (path, MakeCallback (&ns3::ApplicationPacketProbe::TraceSink, this));
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   105
}
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   106
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   107
void
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   108
ApplicationPacketProbe::TraceSink (Ptr<const Packet> packet, const Address& address)
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   109
{
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   110
  NS_LOG_FUNCTION (this << packet << address);
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   111
  if (IsEnabled ())
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   112
    {
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   113
      m_packet  = packet;
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   114
      m_address = address;
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   115
      m_output (packet, address);
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   116
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   117
      uint32_t packetSizeNew = packet->GetSize ();
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   118
      m_outputBytes (m_packetSizeOld, packetSizeNew);
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   119
      m_packetSizeOld = packetSizeNew;
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   120
    }
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   121
}
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   122
848770c90669 data collection extensions for stats module
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   123
} // namespace ns3