IPacketMeter

module interface

This module interface is implemented by 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 meta data they contain. The packets are processed as part of a stream.

Inheritance diagram

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

Implemented by

Name	Type	Description
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.
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.
MultiPacketMeter	compound module	This module combines multiple packet meters into one.
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.
OmittedPacketMeter	compound module	This module implements the module given interface and can be used as an omitted 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 green or red color depending on whether the token bucket contains the required number of tokens for 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.

Used in compound modules

Name	Type	Description
DualIeee8021qFilter	compound module	This module combines two meters and their corresponding filters per path. This is primarily useful for combining a token bucket based metering with an asynchronous packet shaper. Note that the asynchronous packet shaper also has parts in the network interface queue module.
Ieee8021qFilter	compound module	This module implements the IEEE 802.1Q per-stream filtering and policing. The relationship between streams, gates and meters is not one-to-one. The number of streams, gates and meters can be different and the module will take care about the connections between the submodules based on the streamFilterTable parameter.
MultiPacketMeter	compound module	This module combines multiple packet meters into one.
MultiPacketPolicing	compound module	This module combines multiple packet policing modules into one.
PacketPolicing	compound module	This module combines a packet meter and a packet filter into a packet policing module. The meter measures the packet flow that is passing through and attaches some meta information to the packets. The filter drops the packets that don't match the implemented filter criteria.
SimpleIeee8021qFilter	compound module	This module implements a simplified version of the IEEE 802.1Q per-stream filtering and policing. Each filtered stream has its own path where metering and filtering happens independently of any other stream.

Extends

Name	Type	Description
IPacketFlow	module interface	This module interface is implemented by 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
omittedTypename	OmittedPacketFlow
display	i=block/star

Source code

//
// This module interface is implemented by 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 meta data 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