inet::SingleRateThreeColorMeter Class Reference

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

#include <SingleRateThreeColorMeter.h>

Inheritance diagram for inet::SingleRateThreeColorMeter:

Public Member Functions
	SingleRateThreeColorMeter ()

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	CIR = NaN
long	CBS = 0
long	EBS = 0
bool	colorAwareMode = false
long	Tc = 0
long	Te = 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 according to three parameters, Committed Information Rate (CIR), Committed Burst Size (CBS), and Excess Burst Size (EBS), to be either green, yellow or red.

See RFC 2697.

Constructor & Destructor Documentation

inet::SingleRateThreeColorMeter::SingleRateThreeColorMeter ( )

inline

{}

Member Function Documentation

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

overrideprotectedvirtual

{
    cPacket *packet = findIPDatagramInPacket(check_and_cast<cPacket *>(msg));
    if (!packet)
        throw cRuntimeError("SingleRateThreeColorMeter 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::SingleRateThreeColorMeter::initialize ( int  stage )

overrideprotectedvirtual

{
    cSimpleModule::initialize(stage);

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

        CBS = 8 * (int)par("cbs");
        EBS = 8 * (int)par("ebs");
        colorAwareMode = par("colorAwareMode");
        Tc = CBS;
        Te = EBS;
    }
    else if (stage == INITSTAGE_NETWORK_LAYER) {
        const char *cirStr = par("cir");
        IInterfaceTable *ift = findModuleFromPar<IInterfaceTable>(par("interfaceTableModule"), this);
        CIR = parseInformationRate(cirStr, "cir", ift, *this, 0);
        lastUpdateTime = simTime();
    }
}

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

protectedvirtual

{
    // update token buckets
    simtime_t currentTime = simTime();
    long numTokens = (long)(SIMTIME_DBL(currentTime - lastUpdateTime) * CIR);
    lastUpdateTime = currentTime;
    if (Tc + numTokens <= CBS)
        Tc += numTokens;
    else {
        long excessTokens = Tc + numTokens - CBS;
        Tc = CBS;
        if (Te + excessTokens <= EBS)
            Te += excessTokens;
        else
            Te = EBS;
    }

    // update meter state
    int oldColor = colorAwareMode ? getColor(packet) : -1;
    int newColor;
    int packetSizeInBits = packet->getBitLength();
    if (oldColor <= GREEN && Tc - packetSizeInBits >= 0) {
        Tc -= packetSizeInBits;
        newColor = GREEN;
    }
    else if (oldColor <= YELLOW && Te - packetSizeInBits >= 0) {
        Te -= packetSizeInBits;
        newColor = YELLOW;
    }
    else
        newColor = RED;

    setColor(packet, newColor);
    return newColor;
}

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

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

void inet::SingleRateThreeColorMeter::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::SingleRateThreeColorMeter::CBS = 0

protected

double inet::SingleRateThreeColorMeter::CIR = NaN

protected

bool inet::SingleRateThreeColorMeter::colorAwareMode = false

protected

long inet::SingleRateThreeColorMeter::EBS = 0

protected

simtime_t inet::SingleRateThreeColorMeter::lastUpdateTime

protected

int inet::SingleRateThreeColorMeter::numRcvd = 0

protected

int inet::SingleRateThreeColorMeter::numRed = 0

protected

int inet::SingleRateThreeColorMeter::numYellow = 0

protected

long inet::SingleRateThreeColorMeter::Tc = 0

protected

long inet::SingleRateThreeColorMeter::Te = 0

protected

---

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

• SingleRateThreeColorMeter.h
• SingleRateThreeColorMeter.cc