PacketSinkBase

simple module

This is a base module for various packet sink modules.

Inheritance diagram

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

Known subclasses

Name	Type	Description
ActivePacketSink	simple module	This module is an active packet sink which pops packets from the connected packet provider. All popped packets are counted and deleted.
PacketBasedTokenGenerator	simple module	This module generates tokens into the configured TokenBasedServer for each consumed packet.
PacketClassifierBase	simple module	This is a base module for various packet classifier modules. Derived modules must implement a single packet classifier function which determines the index of the output gate for the next pushed packet.
PacketMultiplexer	simple module	This module connects multiple packet producers to one packet consumer. When a packet is pushed by one of the connected packet producers, then the multiplexer simply pushes the packet to the connected packet consumer.
PacketServerBase	simple module	This is a base module for various packet server modules.
PassivePacketSink	simple module	This module is a passive packet sink which is pushed with packets by the connected packet producer. All pushed packets are counted and deleted.
PcapFilePacketConsumer	simple module	This module is a passive packet sink which is pushed with packets by the connected packet producer. All pushed packets are written to a PCAP file.

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	"dropped %p pk (%l)"	determines the text that is written on top of the submodule

Properties

Name	Value	Description
display	i=block/sink

Signals

Name	Type	Unit
packetDropped	inet::Packet

Statistics

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

Source code

//
// This is a base module for various packet sink modules.
//
// @see ~IPacketSink
//
simple PacketSinkBase extends PacketProcessorBase
{
    parameters:
        displayStringTextFormat = default("dropped %p pk (%l)");
        @display("i=block/sink");
        @signal[packetDropped](type=inet::Packet);
        @statistic[packetDropped](title="packets dropped"; record=count,sum(packetBytes),vector(packetBytes); interpolationmode=none);
}

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