C++ definition

Implements a Two Rate Three Color Meter (RFC 2698).

It classifies IP packets based on two rates, Peak Information Rate (PIR) and Committed Information Rate (CIR), and their associated burst sizes to be either green, yellow, or red.

The green traffic is guaranteed to be under (in bits)

  PIR * (t1 - t0) + 8 * PBS and CIR * (t1 - t0) + 8 * CBS

and yellow traffic to be under

  PIR * (t1 - t0) + 8 * PBS

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.

Inheritance diagram

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

Extends

Name	Type	Description
SimpleModule	simple module	Base module for all INET simple modules.

Parameters

Name	Type	Default value	Description
displayStringTextFormat	string	""	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
interfaceTableModule	string		The path to the InterfaceTable module
pir	string		Peak information rate, either absolute bitrate (e.g. "100kbps") or relative to the link's datarate (e.g. "20%")
pbs	int		Peak burst size
cir	string		Committed information rate, either absolute or relative bitrate; must be smaller than the PIR
cbs	int		Committed burst size
colorAwareMode	bool	false	Enables color-aware mode

Properties

Name	Value	Description
class	TwoRateThreeColorMeter
display	i=block/timer

Gates

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

Source code

//
// Implements a Two Rate Three Color Meter (RFC 2698).
//
// It classifies IP packets based on two rates, Peak Information Rate (PIR)
// and Committed Information Rate (CIR), and their associated burst sizes
// to be either green, yellow, or red.
//
// The green traffic is guaranteed to be under (in bits)
// <pre>
//   PIR * (t1 - t0) + 8 * PBS and CIR * (t1 - t0) + 8 * CBS
// </pre>
// and yellow traffic to be under
// <pre>
//   PIR * (t1 - t0) + 8 * PBS
// </pre>
// 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 TwoRateThreeColorMeter extends SimpleModule
{
    parameters:
        @class(TwoRateThreeColorMeter);
        @display("i=block/timer");
        string interfaceTableModule;   // The path to the InterfaceTable module
        string pir;       // Peak information rate, either absolute bitrate (e.g. "100kbps") or relative to the link's datarate (e.g. "20%")
        int pbs @unit(B); // Peak burst size
        string cir;       // Committed information rate, either absolute or relative bitrate; must be smaller than the PIR
        int cbs @unit(B); // Committed burst size
        bool colorAwareMode = default(false); // Enables color-aware mode
    gates:
        input in;
        output greenOut;
        output yellowOut;
        output redOut;
}

File: src/inet/networklayer/diffserv/TwoRateThreeColorMeter.ned

---

This documentation is released under the Creative Commons license