Package: inet.protocolelement.checksum.base

ChecksumInserterBase

simple module

Base module for checksum inserters that add checksums to packets for integrity verification. This module supports multiple checksum algorithms such as CRC32 and the Internet checksum, and also several checksum modes: disabled, declared correct, declared incorrect, and computed. In computed mode, it calculates the actual checksum based on the packet content using the selected checksum algorithm. The checksumMode parameter determines which mode is used.

<b>See also:</b> ChecksumInserterBase

Inheritance diagram

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

Known subclasses

Name	Type	Description
ChecksumHeaderInserter	simple module	Adds a checksum to packets to verify data integrity. This module extends ChecksumInserterBase and adds the ability to specify the position of the checksum header (front or back of the packet). It processes packets by creating a new checksum header, computing the checksum value based on the packet content and checksum mode, setting the checksum value and mode in the header, and inserting the header at the specified position.
EthernetFcsInserter	simple module	(no description)
EthernetFragmentFcsInserter	simple module	(no description)

Extends

Name	Type	Description
PacketFlowBase	simple module	Base module for various packet flow modules. A packet flow module passes or streams all pushed or pulled packets after processing them from its input to its output.

Parameters

Name	Type	Default value	Description
displayStringTextFormat	string	"processed %p pk (%l)"	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
checksumType	string	"ethernet-fcs"
checksumMode	string	"declared"

Properties

Name	Value	Description
class	ChecksumInserterBase
display	i=block/inserter

Gates

Name	Direction	Size	Description
in	input
out	output

Signals

Name	Type	Unit	Description
packetPushedIn	inet::Packet
packetPulledIn	inet::Packet
packetPushedOut	inet::Packet
packetPulledOut	inet::Packet

Statistics

Name	Title	Source	Record	Unit	Interpolation Mode	Description
flowIncomingDataRate	flow specific incoming data rate	throughput(demuxFlow(merge(packetPushedIn, packetPulledIn)))	vector	bps	linear	the statistical value is the flow specific data rate of the incoming packets
outgoingDataRate	outgoing data rate	throughput(merge(packetPushedOut, packetPulledOut))	vector	bps	linear	the statistical value is the data rate of the outgoing packets
incomingDataRate	incoming data rate	throughput(merge(packetPushedIn, packetPulledIn))	vector	bps	linear	the statistical value is the data rate of the incoming packets
outgoingPacketLengths	outgoing packet lengths	packetLength(merge(packetPushedOut, packetPulledOut))	sum, histogram, vector	b	none	the statistical value is the length of the outgoing packet
flowIncomingPacketLengths	flow specific incoming packet lengths	packetLength(demuxFlow(merge(packetPushedIn, packetPulledIn)))	sum, histogram, vector	b	none	the statistical value is the flow specific length of the incoming packet
flowOutgoingDataRate	flow specific outgoing data rate	throughput(demuxFlow(merge(packetPushedOut, packetPulledOut)))	vector	bps	linear	the statistical value is the flow specific data rate of the outgoing packets
incomingPacketLengths	incoming packet lengths	packetLength(merge(packetPushedIn, packetPulledIn))	sum, histogram, vector	b	none	the statistical value is the length of the incoming packet
flowOutgoingPacketLengths	flow specific outgoing packet lengths	packetLength(demuxFlow(merge(packetPushedOut, packetPulledOut)))	sum, histogram, vector	b	none	the statistical value is the flow specific length of the outgoing packet
incomingPackets	incoming packets	merge(packetPushedIn, packetPulledIn)	count	pk		the statistical value is the incoming packet
outgoingPackets	outgoing packets	merge(packetPushedOut, packetPulledOut)	count	pk		the statistical value is the outgoing packet

Source code

//
// Base module for checksum inserters that add checksums to packets for integrity
// verification. This module supports multiple checksum algorithms such as CRC32
// and the Internet checksum, and also several checksum modes: disabled,
// declared correct, declared incorrect, and computed. In computed mode,
// it calculates the actual checksum based on the packet content using the selected
// checksum algorithm. The checksumMode parameter determines which mode is used.
//
// @see ChecksumInserterBase
//
simple ChecksumInserterBase extends PacketFlowBase
{
    parameters:
        string checksumType @enum("internet","ethernet-fcs","crc32c","crc16-ibm","crc16-ccitt") = default("ethernet-fcs");
        string checksumMode @enum("disabled","declared","computed") = default("declared");
        @class(ChecksumInserterBase);
        @display("i=block/inserter");
}

File: src/inet/protocolelement/checksum/base/ChecksumInserterBase.ned