A Discrete-Event Network Simulator
API
packet-filter.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2016 Universita' degli Studi di Napoli Federico II
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 
19 #include "ns3/log.h"
20 #include "ns3/integer.h"
21 #include "queue-disc.h"
22 #include "packet-filter.h"
23 
24 namespace ns3 {
25 
26 NS_LOG_COMPONENT_DEFINE ("PacketFilter");
27 
28 NS_OBJECT_ENSURE_REGISTERED (PacketFilter);
29 
30 TypeId
31 PacketFilter::GetTypeId (void)
32 {
33  static TypeId tid = TypeId ("ns3::PacketFilter")
34  .SetParent<Object> ()
35  .SetGroupName ("TrafficControl")
36  ;
37  return tid;
38 }
39 
40 PacketFilter::PacketFilter ()
41 {
42  NS_LOG_FUNCTION (this);
43 }
44 
45 PacketFilter::~PacketFilter()
46 {
47  NS_LOG_FUNCTION (this);
48 }
49 
50 int32_t
51 PacketFilter::Classify (Ptr<QueueDiscItem> item) const
52 {
53  NS_LOG_FUNCTION (this << item);
54 
55  if (!CheckProtocol (item))
56  {
57  NS_LOG_LOGIC ("Unable to classify packets of this protocol");
58  return PF_NO_MATCH;
59  }
60 
61  return DoClassify (item);
62 }
63 
64 } // namespace ns3
ns3::Object
A base class which provides memory management and object aggregation.
Definition: object.h:88
ns3::PacketFilter::GetTypeId
static TypeId GetTypeId(void)
Get the type ID.
Definition: packet-filter.cc:31
ns3::PacketFilter::Classify
int32_t Classify(Ptr< QueueDiscItem > item) const
Classify a packet.
Definition: packet-filter.cc:51
ns3::PacketFilter::DoClassify
virtual int32_t DoClassify(Ptr< QueueDiscItem > item) const =0
Classify a packet.
ns3::PacketFilter::PF_NO_MATCH
static const int PF_NO_MATCH
Standard value used by packet filters to indicate that no match was possible.
Definition: packet-filter.h:48
ns3::PacketFilter::~PacketFilter
virtual ~PacketFilter()
Definition: packet-filter.cc:45
ns3::PacketFilter::CheckProtocol
virtual bool CheckProtocol(Ptr< QueueDiscItem > item) const =0
Checks if the filter is able to classify a kind of items.
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:74
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
ns3::TypeId::SetParent
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:922
NS_LOG_COMPONENT_DEFINE
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
NS_LOG_LOGIC
#define NS_LOG_LOGIC(msg)
Use NS_LOG to output a message of level LOG_LOGIC.
Definition: log.h:289
NS_LOG_FUNCTION
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
Definition: log-macros-enabled.h:244
NS_OBJECT_ENSURE_REGISTERED
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.