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