PacketScheduler

simple module

This module connects one packet collector to multiple packet providers. It can be pulled for packets by the connected packet collector. When this happens, the scheduler pulls a packet from one of its packet providers based on the configured scheduler function. The packet scheduler function takes a list of packet providers and returns an integer which in turn is used for determining 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 pulled packet.

Parameters

Name	Type	Default value	Description
displayStringTextFormat	string	"scheduled %p pk (%l)"	determines the text that is written on top of the submodule
reverseOrder	bool	false
schedulerClass	string		determines the input queue of the packet, the parameter must be the name of a C++ class which implements the IPacketSchedulerFunction interface and is registered via Register_Class

Properties

Name	Value	Description
display	i=block/join
class	PacketScheduler

Gates

Name	Direction	Size	Description
in [ ]	input
out	output

Signals

Name	Type	Unit
packetPulled	inet::Packet

Statistics

Name	Title	Source	Record	Unit	Interpolation Mode
packetLengths	packet lengths	packetLength(packetPulled)	sum, histogram, vector	b	none
dataRate	data rate	throughput(packetPulled)	vector	bps	linear
packets	packets	packetPulled	count	pk

Direct method calls (observed)

call to	function	info
ActivePacketSink	inet::queueing::ActivePacketSink::handleCanPullPacketChanged	handleCanPullPacketChanged
PassivePacketSource	inet::queueing::PassivePacketSource::canPullPacket	canPullPacket
PassivePacketSource	inet::queueing::PassivePacketSource::pullPacket	pullPacket

Called methods (observed)

function	info	call from
inet::queueing::PacketScheduler::handleCanPullPacketChanged	handleCanPullPacketChanged	PassivePacketSource
inet::queueing::PacketScheduler::pullPacket	pullPacket	ActivePacketSink

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

Packet operations (observed)

chunkType	packetAction
BytesChunk	peekDataAt

Source code

//
// This module connects one packet collector to multiple packet providers. It
// can be pulled for packets by the connected packet collector. When this
// happens, the scheduler pulls a packet from one of its packet providers based
// on the configured scheduler function. The packet scheduler function takes a
// list of packet providers and returns an integer which in turn is used for
// determining the input gate.
//
simple PacketScheduler extends PacketSchedulerBase like IPacketScheduler
{
    parameters:
        string schedulerClass; // determines the input queue of the packet, the parameter must be the name of a C++ class which implements the IPacketSchedulerFunction interface and is registered via Register_Class
        @class(PacketScheduler);
}

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