ContentBasedScheduler

simple module

This module connects one packet collector to multiple packet providers. It can be popped for packets by the connected packet collector. When this happens, the scheduler pops a packet from one of its packet providers based on the configured packet filters. The first matching expression determines the index of the input gate.

Inheritance diagram

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

Extends

Name	Type	Description
PacketSchedulerBase	simple module	This is a base module for various packet scheduler modules. Derived modules must implement a single packet scheduler function which determines the index of the input gate for the popped packet.

Parameters

Name	Type	Default value	Description
displayStringTextFormat	string	"scheduled %p pk (%l)"	determines the text that is written on top of the submodule
defaultGateIndex	int	0	default gate index if no matching labels are found
packetFilters	string		semicolon separated list of packet filter expressions (e.g. ping-;udp-), matches all packets by default
packetDataFilters	string		semicolon separated list of packet data filter expressions (e.g. inet::Ipv4Header and srcAddress = "10.0.0.1"), matches all packets by default

Properties

Name	Value	Description
display	i=block/join
class	ContentBasedScheduler

Gates

Name	Direction	Size	Description
in [ ]	input
out	output

Signals

Name	Type	Unit
packetPopped	inet::Packet

Statistics

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

Source code

//
// This module connects one packet collector to multiple packet providers. It
// can be popped for packets by the connected packet collector. When this
// happens, the scheduler pops a packet from one of its packet providers based
// on the configured packet filters. The first matching expression determines
// the index of the input gate.
//
simple ContentBasedScheduler extends PacketSchedulerBase like IPacketScheduler
{
    parameters:
        int defaultGateIndex = default(0); // default gate index if no matching labels are found
        string packetFilters; // semicolon separated list of packet filter expressions (e.g. ping-*;udp-*), matches all packets by default
        string packetDataFilters; // semicolon separated list of packet data filter expressions (e.g. inet::Ipv4Header and srcAddress = "10.0.0.1"), matches all packets by default
        @class(ContentBasedScheduler);
}

File: src/inet/queueing/scheduler/ContentBasedScheduler.ned