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