IPacketFilter

module interface

Interface for packet filter modules. A packet filter connects one input to one output. It can operate in both active and passive mode. Packets can be pushed into its input or packets can be pulled from its output. Processed packets are either dropped, if they don't match the filter criteria, or they are passed through without any delay or reordering. Packets are not modified in any way.

Inheritance diagram

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

Implemented by

Name	Type	Description
ATSIeee8021qFilter	compound module	Implements a filtering module for the asynchronous traffic shaper taking scheduler groups into account.
BackPressureBasedFilter	simple module	Implements a packet filter that drops packets when the following module (consumer) does not allow packets to be pushed. The module itself accepts all packets (i.e. `canPushPacket()` and `canPushSomePacket()` always return true). This is useful, for example, when the following module is a gate to filter out packets when the gate is closed.
ContentBasedFilter	simple module	Filters packets that match 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. Similarly, when the filter is pulled by a connected packet collector, it pulls packets from the connected packet provider until it finds one that matches the configured packet filter.
DualIeee8021qFilter	compound module	Combines two meters and their corresponding filters per path. This is primarily useful for combining a token bucket based metering with an asynchronous packet shaper. Note that the asynchronous packet shaper also has parts in the network interface queue module.
EligibilityTimeFilter	simple module	A packet filter that operates based on the ~EligibilityTimeTag attached to the packet that is passing through. Packets are dropped if the tag is missing. If the `maxResidenceTime` parameter is set, then the filter also drops the packets for which the eligibility time in the attached ~EligibilityTimeTag is greater than the current simulation time plus the maximum residence time.
EthernetAddressChecker	simple module	Filters Ethernet packets based on their destination MAC address. Extracts source and destination addresses from Ethernet frames and adds them as tags for use by higher layers. Accepts packets where the destination address is the receiving interface's MAC address, the broadcast address, or a multicast address for which the interface has group membership. Drops the rest as "not addressed to us". When in promiscuous mode, accepts all packets regardless of destination address.
EthernetFcsChecker	simple module	(no description)
EthernetFragmentFcsChecker	simple module	(no description)
EthernetFragmentPhyHeaderChecker	simple module	(no description)
EthernetMacHeaderChecker	simple module	(no description)
EthernetPhyHeaderChecker	simple module	(no description)
EthernetTypeOrLengthChecker	simple module	(no description)
Ieee8021qFilter	compound module	Implements the IEEE 802.1Q per-stream filtering and policing. The relationship between streams, gates, and meters is not one-to-one. The number of streams, gates, and meters can be different, and the module will take care of the connections between the submodules based on the `streamFilterTable` parameter.
Ieee8021qTagEpdHeaderChecker	simple module	(no description)
Ieee8021qTagTpidHeaderChecker	simple module	(no description)
Ieee8021rTagEpdHeaderChecker	simple module	(no description)
LabelFilter	simple module	This packet filter module drops packets that don't match the given packet label filter criteria. The criteria can use wildcards and Boolean operators.
MultiPacketFilter	compound module	Combines multiple packet filters into one.
OmittedIeee8021qTagEpdHeaderChecker	compound module	Implements the module given interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialization.
OmittedIeee8021qTagTpidHeaderChecker	compound module	Implements the module given interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialize.
OmittedPacketFilter	compound module	Implements the given module interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialization.
PacketFilter	simple module	Filters packets that match 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. Similarly, when the filter is pulled by a connected packet collector, it pulls packets from the connected packet provider until it finds one that matches the configured packet filter.
SimpleIeee8021qFilter	compound module	Implements a simplified version of the IEEE 802.1Q per-stream filtering and policing. Each filtered stream has its own path where metering and filtering happens independently of any other stream.
StatisticalRateLimiter	simple module	Limits the datarate or the packetrate of a stream of packets based on the ~RateTag attached to the packets.
StreamFilter	simple module	Implements a packet filter using solely the stream name. The stream name must match the filter criteria in order for the packet to pass through the filter.
StreamMerger	simple module	Merges the packets of the same stream by removing duplicates. In addition, it also replaces the stream name on the packet based on the mapping parameter. For merging, it maintains a separate finite buffer per stream with the last seen sequence numbers.
VlanIndFilter	simple module	Filters out packets based on the attached `VlanInd` tag.
VlanReqFilter	simple module	Filters out packets based on the attached `VlanReq` tag.

Used in compound modules

Name	Type	Description
DualIeee8021qFilter	compound module	Combines two meters and their corresponding filters per path. This is primarily useful for combining a token bucket based metering with an asynchronous packet shaper. Note that the asynchronous packet shaper also has parts in the network interface queue module.
EthernetFragmentingMacLayer	compound module	(no description)
EthernetLayer	compound module	(no description)
EthernetMacLayer	compound module	(no description)
EthernetPhyLayer	compound module	(no description)
EthernetPreemptingPhyLayer	compound module	(no description)
EthernetStreamingMacLayer	compound module	(no description)
Ieee8021qFilter	compound module	Implements the IEEE 802.1Q per-stream filtering and policing. The relationship between streams, gates, and meters is not one-to-one. The number of streams, gates, and meters can be different, and the module will take care of the connections between the submodules based on the `streamFilterTable` parameter.
MultiPacketFilter	compound module	Combines multiple packet filters into one.
MultiPacketPolicing	compound module	Combines multiple packet policing modules into one.
PacketPolicing	compound module	Combines a packet meter and a packet filter into a packet policing module. The meter measures the packet flow that is passing through and attaches some meta information to the packets. The filter drops the packets that do not match the implemented filter criteria.
SimpleIeee8021qFilter	compound module	Implements a simplified version of the IEEE 802.1Q per-stream filtering and policing. Each filtered stream has its own path where metering and filtering happens independently of any other stream.
StreamFilterLayer	compound module	Combines two packet filters into a protocol layer so that it can be used in a layered compound module. There are separate submodules for ingress and egress traffic, but in most cases only the ingress filter is used.
StreamRelayLayer	compound module	Combines a stream merger and a stream splitter module into a stream relay layer. For incoming packets, the identified streams are merged by the stream merger. For outgoing packets, the requested streams are split by the stream splitter.
VlanPolicyLayer	compound module	(no description)

Used in

Name	Type	Description
PeekingUnderTheHoodShowcase	network	(no description)

Known subclasses

Name	Type	Description
IProtocolHeaderChecker	module interface	Module interface for protocol header checker components. Modules that implement this interface verify protocol-specific headers in packets and typically remove them after successful validation. These components act as packet filters that can drop invalid packets based on header information, ensuring protocol compliance and integrity. They are commonly used in protocol stacks to process incoming packets before passing them to higher layers.

Extends

Name	Type	Description
IPacketFlow	module interface	Interface for packet flows. A packet flow connects one input to one output. It can operate in both active and passive mode. Packets can be pushed into its input or packets can be pulled from its output. Packets are never dropped but the contents and/or attached meta information may be altered.

Properties

Name	Value	Description
omittedTypename	OmittedPacketFilter
display	i=block/filter

Source code

//
// Interface for packet filter modules. A packet filter
// connects one input to one output. It can operate in both active and passive
// mode. Packets can be pushed into its input or packets can be pulled from its
// output. Processed packets are either dropped, if they don't match the filter
// criteria, or they are passed through without any delay or reordering. Packets
// are not modified in any way.
//
moduleinterface IPacketFilter extends IPacketFlow
{
    parameters:
        @omittedTypename(OmittedPacketFilter);
        @display("i=block/filter");
}

File: src/inet/queueing/contract/IPacketFilter.ned