inet::TwoRateThreeColorMeter Class Reference

This class can be used as a meter in an ITrafficConditioner. More...

#include <TwoRateThreeColorMeter.h>

Inheritance diagram for inet::TwoRateThreeColorMeter:

Public Member Functions
	TwoRateThreeColorMeter ()

Protected Member Functions
virtual int	numInitStages () const override
virtual void	initialize (int stage) override
virtual void	handleMessage (cMessage *msg) override
virtual void	refreshDisplay () const override
virtual int	meterPacket (cPacket *packet)

Protected Attributes
double	PIR = NaN
long	PBS = 0
double	CIR = NaN
long	CBS = 0
bool	colorAwareMode = false
long	Tp = 0
long	Tc = 0
simtime_t	lastUpdateTime
int	numRcvd = 0
int	numYellow = 0
int	numRed = 0

Detailed Description

This class can be used as a meter in an ITrafficConditioner.

It marks the 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.

See RFC 2698.

Constructor & Destructor Documentation

inet::TwoRateThreeColorMeter::TwoRateThreeColorMeter ( )

inline

{}

Member Function Documentation

void inet::TwoRateThreeColorMeter::handleMessage ( cMessage *  msg )

overrideprotectedvirtual

{
    cPacket *packet = findIPDatagramInPacket(check_and_cast<cPacket *>(msg));
    if (!packet)
        throw cRuntimeError("TwoRateThreeColorMeter received a packet that does not encapsulate an IP datagram.");

    numRcvd++;
    int color = meterPacket(packet);
    switch (color) {
        case GREEN:
            send(packet, "greenOut");
            break;

        case YELLOW:
            numYellow++;
            send(packet, "yellowOut");
            break;

        case RED:
            numRed++;
            send(packet, "redOut");
            break;
    }
}

void inet::TwoRateThreeColorMeter::initialize ( int  stage )

overrideprotectedvirtual

{
    cSimpleModule::initialize(stage);

    if (stage == INITSTAGE_LOCAL) {
        numRcvd = 0;
        numYellow = 0;
        numRed = 0;
        WATCH(numRcvd);
        WATCH(numYellow);
        WATCH(numRed);

        PBS = 8 * (int)par("pbs");
        CBS = 8 * (int)par("cbs");
        colorAwareMode = par("colorAwareMode");
        Tp = PBS;
        Tc = CBS;
    }
    else if (stage == INITSTAGE_NETWORK_LAYER) {
        IInterfaceTable *ift = findModuleFromPar<IInterfaceTable>(par("interfaceTableModule"), this);
        PIR = parseInformationRate(par("pir"), "pir", ift, *this, 0);
        CIR = parseInformationRate(par("cir"), "cir", ift, *this, 0);
        lastUpdateTime = simTime();
    }
}

int inet::TwoRateThreeColorMeter::meterPacket ( cPacket *  packet )

protectedvirtual

{
    // update token buckets
    simtime_t currentTime = simTime();
    double elapsedTime = SIMTIME_DBL(currentTime - lastUpdateTime);
    lastUpdateTime = currentTime;
    long numTokens = (long)(elapsedTime * PIR);
    if (Tp + numTokens <= PBS)
        Tp += numTokens;
    else
        Tp = PBS;
    numTokens = (long)(elapsedTime * CIR);
    if (Tc + numTokens <= CBS)
        Tc += numTokens;
    else
        Tc = CBS;

    // update meter state
    int oldColor = colorAwareMode ? getColor(packet) : -1;
    int newColor;
    int packetSizeInBits = 8 * packet->getByteLength();
    if (oldColor == RED || Tp - packetSizeInBits < 0) {
        newColor = RED;
    }
    else if (oldColor == YELLOW || Tc - packetSizeInBits < 0) {
        Tp -= packetSizeInBits;
        newColor = YELLOW;
    }
    else {
        Tp -= packetSizeInBits;
        Tc -= packetSizeInBits;
        newColor = GREEN;
    }

    setColor(packet, newColor);
    return newColor;
}

virtual int inet::TwoRateThreeColorMeter::numInitStages ( ) const

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

void inet::TwoRateThreeColorMeter::refreshDisplay ( ) const

overrideprotectedvirtual

{
    char buf[80] = "";
    if (numRcvd > 0)
        sprintf(buf + strlen(buf), "rcvd: %d ", numRcvd);
    if (numYellow > 0)
        sprintf(buf + strlen(buf), "yellow:%d ", numYellow);
    if (numRed > 0)
        sprintf(buf + strlen(buf), "red:%d ", numRed);
    getDisplayString().setTagArg("t", 0, buf);
}

Member Data Documentation

long inet::TwoRateThreeColorMeter::CBS = 0

protected

double inet::TwoRateThreeColorMeter::CIR = NaN

protected

bool inet::TwoRateThreeColorMeter::colorAwareMode = false

protected

simtime_t inet::TwoRateThreeColorMeter::lastUpdateTime

protected

int inet::TwoRateThreeColorMeter::numRcvd = 0

protected

int inet::TwoRateThreeColorMeter::numRed = 0

protected

int inet::TwoRateThreeColorMeter::numYellow = 0

protected

long inet::TwoRateThreeColorMeter::PBS = 0

protected

double inet::TwoRateThreeColorMeter::PIR = NaN

protected

long inet::TwoRateThreeColorMeter::Tc = 0

protected

long inet::TwoRateThreeColorMeter::Tp = 0

protected

---

The documentation for this class was generated from the following files:

• TwoRateThreeColorMeter.h
• TwoRateThreeColorMeter.cc