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 pulled by a connected packet collector, it pulls 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
backpressure	bool	false
packetFilter	object	"*"	packet filter expressions, matches all packets by default

Properties

Name	Value	Description
display	i=block/downarrow
class	ContentBasedFilter

Gates

Name	Direction	Size	Description
in	input
out	output

Signals

Name	Type	Unit
packetPushedIn	inet::Packet
packetPulledIn	inet::Packet
packetDropped	inet::Packet
packetPushedOut	inet::Packet
packetPulledOut	inet::Packet

Statistics

Name	Title	Source	Record	Unit	Interpolation Mode
flowDroppedPacketLengths	flow specific dropped packet lengths	packetLength(demuxFlow(packetDropped))	sum, histogram, vector	b	none
incomingDataRate	incoming data rate	throughput(merge(packetPushedIn, packetPulledIn))	vector	bps	linear
droppedPacketLengths	dropped packet lengths	packetLength(packetDropped)	sum, histogram, vector	b	none
incomingPacketLengths	incoming packet lengths	packetLength(merge(packetPushedIn, packetPulledIn))	sum, histogram, vector	b	none
droppedDataRate	dropped data rate	throughput(packetDropped)	vector	bps	linear
flowOutgoingPacketLengths	flow specific outgoing packet lengths	packetLength(demuxFlow(merge(packetPushedOut, packetPulledOut)))	sum, histogram, vector	b	none
flowDroppedDataRate	flow specific dropped data rate	throughput(demuxFlow(packetDropped))	vector	bps	linear
droppedPackets	dropped packets	packetDropped	count	pk
flowIncomingDataRate	flow specific incoming data rate	throughput(demuxFlow(merge(packetPushedIn, packetPulledIn)))	vector	bps	linear
outgoingDataRate	outgoing data rate	throughput(merge(packetPushedOut, packetPulledOut))	vector	bps	linear
outgoingPacketLengths	outgoing packet lengths	packetLength(merge(packetPushedOut, packetPulledOut))	sum, histogram, vector	b	none
flowIncomingPacketLengths	flow specific incoming packet lengths	packetLength(demuxFlow(merge(packetPushedIn, packetPulledIn)))	sum, histogram, vector	b	none
flowOutgoingDataRate	flow specific outgoing data rate	throughput(demuxFlow(merge(packetPushedOut, packetPulledOut)))	vector	bps	linear
incomingPackets	incoming packets	merge(packetPushedIn, packetPulledIn)	count	pk
outgoingPackets	outgoing packets	merge(packetPushedOut, packetPulledOut)	count	pk

Direct method calls (observed)

call to	function	info
ContentBasedFilter	inet::queueing::ContentBasedFilter::canPullPacket	canPullPacket
ActivePacketSink	inet::queueing::ActivePacketSink::handleCanPullPacketChanged	handleCanPullPacketChanged
PassivePacketSink	inet::queueing::PassivePacketSink::pushPacket	pushPacket
ActivePacketSource	inet::queueing::ActivePacketSource::handleCanPushPacketChanged	handleCanPushPacketChanged
PassivePacketSource	inet::queueing::PassivePacketSource::canPullPacket	canPullPacket
PassivePacketSource	inet::queueing::PassivePacketSource::pullPacket	pullPacket

Called methods (observed)

function	info	call from
inet::queueing::ContentBasedFilter::canPullPacket	canPullPacket	ContentBasedFilter
inet::queueing::ContentBasedFilter::canPullSomePacket	canPullSomePacket	ActivePacketSink
inet::queueing::ContentBasedFilter::handleCanPullPacketChanged	handleCanPullPacketChanged	PassivePacketSource
inet::queueing::ContentBasedFilter::handleCanPushPacketChanged	handleCanPushPacketChanged	PassivePacketSink
inet::queueing::ContentBasedFilter::pullPacket	pullPacket	ActivePacketSink
inet::queueing::ContentBasedFilter::pushPacket	pushPacket	ActivePacketSource

Pull in messages (observed)

gate	msg	kind	ctrl	srcModule	tags
in	Packet	0		PassivePacketSource	DirectionTag, PacketProtocolTag

Pulled out messages (observed)

gate	msg	kind	ctrl	destModule	tags
out	Packet	0		ActivePacketSink	DirectionTag, PacketProtocolTag

Pushed in messages (observed)

gate	msg	kind	ctrl	srcModule	tags
in	Packet	0		ActivePacketSource	DirectionTag, PacketProtocolTag

Push out messages (observed)

gate	msg	kind	ctrl	destModule	tags
out	Packet	0		PassivePacketSink	DirectionTag, PacketProtocolTag

Packet operations (observed)

chunkType	packetAction
	peekData, setBackOffset, setFrontOffset

Shared Tagging operations (observed)

tagType	tagAction
PacketProtocolTag	findTag

Region Tagging operations (observed)

tagType	tagAction
FlowTag	mapAllTags

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 pulled by a connected
// packet collector, it pulls packets from the connected packet provider until
// it finds one which matches the configured packet filter.
//
simple ContentBasedFilter extends PacketFilterBase like IPacketFilter
{
    parameters:
        object packetFilter = default("*"); // packet filter expressions, matches all packets by default
        @class(ContentBasedFilter);
}

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

---

This documentation is released under the Creative Commons license