This is a base module for various packet sink modules.

See also: IPacketSink

Inheritance diagram

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

Known subclasses

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

Extends

Name	Type	Description
PacketProcessorBase	simple module	This is a 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

Properties

Name	Value	Description
display	i=block/sink
class	PacketSinkBase

Signals

Name	Type	Unit
packetDropped	inet::Packet

Statistics

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

Source code

//
// This is a 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

---

This documentation is released under the Creative Commons license