PacketSinkBase¶

simple module PacketSinkBase

Base module for various packet sink modules.

Inheritance diagram¶

Known subclasses¶

Name	Type	Description
ActivePacketSinkBase	simple module	Base module for various active packet sink modules.
PassivePacketSinkBase	simple module	Base module for various active packet sink modules.

Extends¶

Name	Type	Description
PacketProcessorBase	simple module	Base module for various packet processing modules which maintains a few statistics.

Parameters¶

Name	Type	Default value	Description
displayStringTextFormat	string	“received %p pk (%l)”	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information

Properties¶

Name	Value	Description
class	PacketSinkBase
display	i=block/sink

Signals¶

Name	Type	Unit	Description
packetDropped	inet::Packet

Statistics¶

Name	Title	Source	Record	Unit	Interpolation Mode	Description
droppedDataRate	dropped data rate	throughput(packetDropped)	vector	bps	linear	the statistical value is the data rate of the dropped packets
droppedPacketLengths	dropped packet lengths	packetLength(packetDropped)	sum,histogram,vector	b	none	the statistical value is the length of the dropped packet
droppedPackets	dropped packets	packetDropped	count	pk		the statistical value is the dropped packet

Source code¶

//
// Base module for various packet sink modules.
//
// @see ~IPacketSink
//
simple PacketSinkBase extends PacketProcessorBase
{
    parameters:
        displayStringTextFormat = default("received %p pk (%l)");
        @class(PacketSinkBase);
        @display("i=block/sink");
        @signal[packetDropped](type=inet::Packet);
        // the statistical value is the dropped packet
        @statistic[droppedPackets](title="dropped packets"; source=packetDropped; record=count; unit=pk);
        // the statistical value is the length of the dropped packet
        @statistic[droppedPacketLengths](title="dropped packet lengths"; source=packetLength(packetDropped); record=sum,histogram,vector; unit=b; interpolationmode=none);
        // the statistical value is the data rate of the dropped packets
        @statistic[droppedDataRate](title="dropped data rate"; source=throughput(packetDropped); record=vector; unit=bps; interpolationmode=linear);
}

File: src/inet/queueing/base/PacketSinkBase.ned