SlidingWindowRateMeter

Package: inet.queueing.meter

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.

Inheritance diagram

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

Extends

Name Type Description
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.

Parameters

Name Type Default value Description
displayStringTextFormat string "metered %p pk (%l)"

determines the text that is written on top of the submodule

timeWindow double

amount of time to look back from the current simulation time

Properties

Name Value Description
display i=block/star
class SlidingWindowRateMeter

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

Direct method calls (observed)

call tofunctioninfo
StatisticalRateLimiterinet::queueing::StatisticalRateLimiter::pushPacketpushPacket

Called methods (observed)

functioninfocall from
inet::queueing::SlidingWindowRateMeter::pushPacketpushPacketInteractiveGate

Pushed in messages (observed)

gatemsgkindctrlsrcModuletags
inPacket0InteractiveGateDirectionTag, DispatchProtocolReq, DropEligibleInd, EncapsulationProtocolInd, InterfaceInd, MacAddressInd, PacketProtocolTag, PcpInd, StreamInd, UserPriorityInd, VlanInd

Push out messages (observed)

gatemsgkindctrldestModuletags
outPacket0StatisticalRateLimiterDirectionTag, DispatchProtocolReq, DropEligibleInd, EncapsulationProtocolInd, InterfaceInd, MacAddressInd, PacketProtocolTag, PcpInd, RateTag, StreamInd, UserPriorityInd, VlanInd

Shared Tagging operations (observed)

tagTypetagAction
RateTagaddTagIfAbsent

Region Tagging operations (observed)

tagTypetagAction
FlowTagmapAllTags

Source code

//
// 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.
//
simple SlidingWindowRateMeter extends PacketMeterBase like IPacketMeter
{
    parameters:
        double timeWindow @unit(s); // amount of time to look back from the current simulation time
        @class(SlidingWindowRateMeter);
}
File: src/inet/queueing/meter/SlidingWindowRateMeter.ned