IPacketMeter¶

module interface IPacketMeter

Interface for packet meter modules. A packet meter connects one input to one output. It can operate in both active and passive mode. Packets can be pushed into its input or packets can be pulled from its output. When processing packets, a meter attaches some information (such as the packet rate) to the packets based on the data and metadata they contain. The packets are processed as part of a stream.

Usage diagram¶

Inheritance diagram¶

Implemented by¶

Name	Type	Description
EligibilityTimeMeter	simple module	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 eligible for transmission according to the asynchronous shaper algorithm.
GroupEligibilityTimeMeter	simple module	Extends the `EligibilityTimeMeter` with scheduler groups. The calculation of the eligibility time takes into account the eligibility times of all streams of the same group.
DualRateThreeColorMeter	simple module	This packet meter module measures the packet flow that is passing through using two token buckets. The meter attaches a LabelsTag to each packet with either green, yellow, or red color depending on which token bucket contains the required number of tokens for the packet.
ExponentialRateMeter	simple module	Attaches a RateTag to each packet specifying the data rate and packet rate of the received stream of packets. The algorithm takes older packets into account with an exponentially decreasing weight.
MultiPacketMeter	compound module	Combines multiple packet meters into one.
MultiTokenBucketMeter	simple 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.
OmittedPacketMeter	compound module	Implements the module given interface and can be used as an optional module that removes itself from the module hierarchy during initialize.
SingleRateThreeColorMeter	simple module	This packet meter module measures the packet flow that is passing through using two token buckets. The meter attaches a LabelsTag to each packet with either green, yellow, or red color depending on which token bucket contains the required number of tokens for the packet.
SingleRateTwoColorMeter	simple module	This packet meter module measures the packet flow that is passing through using one token bucket. The meter attaches a LabelsTag to each packet with either a green or red color depending on whether the token bucket contains the required number of tokens for the packet.
SlidingWindowRateMeter	simple module	Attaches a RateTag to each packet specifying the data rate and packet rate of the received stream of packets. The algorithm takes packets into account only in the given time window.
TokenBucketMeter	simple 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.

Used in compound modules¶

Name	Type	Description
MultiPacketMeter	compound module	Combines multiple packet meters into one.

Extends¶

Name	Type	Description
IPacketFlow	module interface	Interface for packet flows. A packet flow connects one input to one output. It can operate in both active and passive mode. Packets can be pushed into its input or packets can be pulled from its output. Packets are never dropped but the contents and/or attached meta information may be altered.

Properties¶

Name	Value	Description
display	i=block/star
omittedTypename	OmittedPacketMeter

Source code¶

//
// Interface for packet meter modules. A packet meter
// connects one input to one output. It can operate in both active and passive
// mode. Packets can be pushed into its input or packets can be pulled from its
// output. When processing packets, a meter attaches some information (such as
// the packet rate) to the packets based on the data and metadata they contain.
// The packets are processed as part of a stream.
//
moduleinterface IPacketMeter extends IPacketFlow
{
    parameters:
        @omittedTypename(OmittedPacketMeter);
        @display("i=block/star");
}

File: src/inet/queueing/contract/IPacketMeter.ned