PacketMeterBase

Package: inet.queueing.base

PacketMeterBase

simple module

This is a base module for various packet meter modules. Derived modules must implement a single meterPacket() function which meters the flow of and attaches the required tags.

See also: IPacketMeter

Inheritance diagram

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

Known subclasses

Name Type Description
EligibilityTimeMeter simple module

This module is a packet meter which measures the packet flow that is passing through and optionally attaches an EligibilityTimeTag to the packets. The tag contains the calculated simulation time when the packet becomes eligibile for transmission according to the asynchronous shaper algorithm.

ExponentialRateMeter simple module

This module attaches a RateTag to each packet specifying the datarate and packetrate of the received stream of packets. The algorithm takes older packets into account with an exponentially decreasing weight.

MultiTokenBucketMeter simple module

This module labels packets according to the first token bucket that contains the required number of tokens. If no such token bucket is found then the default label is attached to the packet.

SlidingWindowRateMeter simple module

This module attaches a RateTag to each packet specifying the datarate and packetrate of the received stream of packets. The algorithm takes packets into account only in the given time window.

TokenBucketMeter simple module

This module labels each packet if the token bucket contains enough tokens for the packet that is passing through. The amount of required tokens is equal to the packet length in bits and is subtracted from the number of stored tokens. New tokens are generated with the provided constant rate and they may also be added by other modules.

Extends

Name Type Description
PacketFlowBase simple module

This is a 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 "metered %p pk (%l)"

determines the text that is written on top of the submodule

Properties

Name Value Description
display i=block/star
class PacketMeterBase

Gates

Name Direction Size Description
in input
out output

Signals

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

Statistics

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

Source code

//
// This is a base module for various packet meter modules. Derived modules must
// implement a single meterPacket() function which meters the flow of and attaches
// the required tags.
//
// @see ~IPacketMeter
//
simple PacketMeterBase extends PacketFlowBase
{
    parameters:
        displayStringTextFormat = default("metered %p pk (%l)");
        @display("i=block/star");
        @class(PacketMeterBase);
}
File: src/inet/queueing/base/PacketMeterBase.ned