A Discrete-Event Network Simulator
API
packet-filter.h
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 #ifndef PACKET_FILTER_H
19 #define PACKET_FILTER_H
20 
21 #include "ns3/object.h"
22 
23 namespace ns3
24 {
25 
26 class QueueDiscItem;
27 
34 class PacketFilter : public Object
35 {
36  public:
41  static TypeId GetTypeId();
42 
43  PacketFilter();
44  ~PacketFilter() override;
45 
49  static const int PF_NO_MATCH = -1;
50 
60  int32_t Classify(Ptr<QueueDiscItem> item) const;
61 
62  private:
69  virtual bool CheckProtocol(Ptr<QueueDiscItem> item) const = 0;
70 
79  virtual int32_t DoClassify(Ptr<QueueDiscItem> item) const = 0;
80 };
81 
82 } // namespace ns3
83 
84 #endif /* PACKET_FILTER */
A base class which provides memory management and object aggregation.
Definition: object.h:89
PacketFilter is the abstract base class for filters used by queue discs to classify packets.
Definition: packet-filter.h:35
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
Every class exported by the ns3 library is enclosed in the ns3 namespace.