This module filters for packets matching the configured filter criteria. When the filter is pushed by a connected packet producer, it either pushes the packet to the connected packet consumer or drops it depending on the configured packet filter. Similarily, when the filter is popped by a connected packet collector, it pops packets from the connected packet provider until it finds one which matches the configured packet filter.

Inheritance diagram

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Extends

Name	Type	Description
PacketFilterBase	simple module	This is a base module for various packet filter modules. Derived modules must implement a single packet matcher function which determines if a packet is to be passed through or filtered out.

Parameters

Name	Type	Default value	Description
displayStringTextFormat	string	"dropped %d/%p pk (%k/%l)"	determines the text that is written on top of the submodule
filterClass	string		determines the packets which pass the filter, the parameter must be the name of a C++ class which implements the IPacketFilterFunction interface and is registered via Register_Class

Properties

Name	Value	Description
display	i=block/downarrow
class	PacketFilter

Gates

Name	Direction	Size	Description
in	input
out	output

Signals

Name	Type	Unit
packetPushed	inet::Packet
packetDropped	inet::Packet
packetPopped	inet::Packet

Statistics

Name	Title	Source	Record	Unit	Interpolation Mode
packetPushed	packets pushed		count, sum(packetBytes), vector(packetBytes)		none
packetDropped	packets dropped		count, sum(packetBytes), vector(packetBytes)		none
packetPopped	packets popped		count, sum(packetBytes), vector(packetBytes)		none

Source code

//
// This module filters for packets matching the configured filter criteria.
// When the filter is pushed by a connected packet producer, it either pushes
// the packet to the connected packet consumer or drops it depending on the
// configured packet filter. Similarily, when the filter is popped by a connected
// packet collector, it pops packets from the connected packet provider until
// it finds one which matches the configured packet filter.
//
simple PacketFilter extends PacketFilterBase like IPacketFilter
{
    parameters:
        string filterClass; // determines the packets which pass the filter, the parameter must be the name of a C++ class which implements the IPacketFilterFunction interface and is registered via Register_Class
        @class(PacketFilter);
}

File: src/inet/queueing/filter/PacketFilter.ned

---

This documentation is released under the Creative Commons license