ActivePacketSink

simple module

This module is an active packet sink which pulls packets from the connected packet provider. All pulled packets are counted and deleted.

Inheritance diagram

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

Used in

Name	Type	Description
BufferTutorialStep	network	(no description)
ComparatorTutorialStep	network	(no description)
CompoundPacketQueueTutorialStep	network	(no description)
ContentBasedSchedulerTutorialStep	network	(no description)
DemultiplexerTutorialStep	network	(no description)
DropTailQueueTutorialStep	network	(no description)
Filter2TutorialStep	network	(no description)
Gate2TutorialStep	network	(no description)
GenericSchedulerTutorialStep	network	(no description)
MarkovSchedulerTutorialStep	network	(no description)
PacketQueueTutorialStep	network	(no description)
PriorityBufferTutorialStep	network	(no description)
PriorityClassifierTutorialStep	network	(no description)
PriorityQueueTutorialStep	network	(no description)
PrioritySchedulerTutorialStep	network	(no description)
ProviderCollectorTutorialStep	network	(no description)
QueueBasedTokenGeneratorTutorialStep	network	(no description)
QueueFillerTutorialStep	network	(no description)
RedDropperTutorialStep	network	(no description)
WrrSchedulerTutorialStep	network	(no description)

Extends

Name	Type	Description
ActivePacketSinkBase	simple module	This is a base module for various active packet sink modules.

Parameters

Name	Type	Default value	Description
displayStringTextFormat	string	"received %p pk (%l)"	determines the text that is written on top of the submodule
clockModule	string	""	relative path of a module that implements IClock(1,2); optional
initialCollectionOffset	double	0s
collectionInterval	double		elapsed time between subsequent packets pulled from the connected packet provider
scheduleForAbsoluteTime	bool	true	when a clock is used relative means that setting the clock will not affect the simulation time of the event

Properties

Name	Value	Description
display	i=block/sink
class	ActivePacketSink

Gates

Name	Direction	Size	Description
in	input

Signals

Name	Type	Unit
packetPulled	inet::Packet

Statistics

Name	Title	Source	Record	Unit	Interpolation Mode
packetDelayVariation	packet delay variation	stddev(weightedMeanPerGroup(groupRegionsPerPacket(lifeTimePerRegion(packetPulled))))	vector, histogram	s
packetDelayDifferenceToMean	packet delay difference to mean	differenceToMean(weightedMeanPerGroup(groupRegionsPerPacket(lifeTimePerRegion(packetPulled))))	vector, histogram	s	none
meanBitLifeTimePerPacket	mean bit life time per packet	weightedMeanPerGroup(groupRegionsPerPacket(lifeTimePerRegion(packetPulled)))	vector, histogram	s	none
packetLengths	packet lengths	packetLength(packetPulled)	sum, histogram, vector	b	none
dataRate	data rate	throughput(packetPulled)	vector	bps	linear
packetJitter	packet jitter	jitter(weightedMeanPerGroup(groupRegionsPerPacket(lifeTimePerRegion(packetPulled))))	vector, histogram	s	none
bitLifeTime	bit life time	weightTimes(lengthWeightedValuePerRegion(lifeTimePerRegion(packetPulled)))	histogram?	s	none
packets	packets	packetPulled	count	pk

Source code

//
// This module is an active packet sink which pulls packets from the connected
// packet provider. All pulled packets are counted and deleted.
//
simple ActivePacketSink extends ActivePacketSinkBase like IActivePacketSink
{
    parameters:
        string clockModule = default(""); // relative path of a module that implements IClock; optional
        double initialCollectionOffset @unit(s) = default(0s);
        volatile double collectionInterval @unit(s); // elapsed time between subsequent packets pulled from the connected packet provider
        bool scheduleForAbsoluteTime = default(true); // when a clock is used relative means that setting the clock will not affect the simulation time of the event
        @class(ActivePacketSink);
    gates:
        input in @labels(pull);
}

File: src/inet/queueing/sink/ActivePacketSink.ned