Simple Module SingleRateThreeColorMeter

Package: inet.networklayer.diffserv
File: src/inet/networklayer/diffserv/SingleRateThreeColorMeter.ned

This module implements a Single Rate Three Color Meter (RFC 2697).

IP packets are classified according to three parameters, Committed Information Rate (cir), Committed Burst Size (cbs), and Excess Burst Size (ebs), to be either green, yellow or red.

The green traffic is guaranteed to be under (in bits) cir * (t1 - t0) + 8 * cbs, and green+yellow traffic to be under cir * (t1 - t0) + 8 * (cbs + ebs) in every [t0,t1] interval.

When operating in color-aware mode, the meter does not recolor a packet that was colored by a previous marker to a lesser conforming color.

Usage diagram:

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Inheritance diagram:

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

Used in compound modules:

Name	Type	Description
TrafficConditioner	compound module	TODO documentation

Parameters:

Name	Type	Default value	Description
interfaceTableModule	string		The path to the InterfaceTable module
cir	string		committed information rate, either absolute bitrate (e.g. "100kbps"), or relative to the link's datarate (e.g. "20%")
cbs	int		committed burst size
ebs	int		excess burst size
colorAwareMode	bool	false	enables color-aware mode

Properties:

Name	Value	Description
display	i=block/timer

Gates:

Name	Direction	Size	Description
in [ ]	input
greenOut	output
yellowOut	output
redOut	output

Source code:

//
// This module implements a Single Rate Three Color Meter (RFC 2697).
//
// IP packets are classified according to three parameters,
// Committed Information Rate (cir), Committed Burst Size (cbs),
// and Excess Burst Size (ebs), to be either green, yellow or red.
//
// The green traffic is guaranteed to be under (in bits)
//    cir * (t1 - t0) + 8 * cbs,
// and green+yellow traffic to be under
//    cir * (t1 - t0) + 8 * (cbs + ebs)
// in every [t0,t1] interval.
//
// When operating in color-aware mode, the meter does not recolor
// a packet that was colored by a previous marker to a lesser
// conforming color.
//
simple SingleRateThreeColorMeter
{
    parameters:
        @display("i=block/timer");
        string interfaceTableModule;   // The path to the InterfaceTable module
        string cir;       // committed information rate, either absolute bitrate (e.g. "100kbps"), or relative to the link's datarate (e.g. "20%")
        int cbs @unit(B); // committed burst size
        int ebs @unit(B); // excess burst size
        bool colorAwareMode = default(false); // enables color-aware mode
    gates:
        input in[];
        output greenOut;
        output yellowOut;
        output redOut;
}