inet::TokenBucketMeter Class Reference

Simple token bucket meter. More...

#include <TokenBucketMeter.h>

Inheritance diagram for inet::TokenBucketMeter:

Public Member Functions
	TokenBucketMeter ()

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
bool	colorAwareMode = false
long	Tc = 0
simtime_t	lastUpdateTime
int	numRcvd = 0
int	numRed = 0

Detailed Description

Simple token bucket meter.

Constructor & Destructor Documentation

inet::TokenBucketMeter::TokenBucketMeter ( )

inline

{}

Member Function Documentation

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

overrideprotectedvirtual

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

    numRcvd++;
    int color = meterPacket(packet);
    if (color == GREEN) {
        send(packet, "greenOut");
    }
    else {
        numRed++;
        send(packet, "redOut");
    }
}

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

overrideprotectedvirtual

{
    cSimpleModule::initialize(stage);

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

        CBS = 8 * (int)par("cbs");
        colorAwareMode = par("colorAwareMode");
        Tc = CBS;
    }
    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::TokenBucketMeter::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
        Tc = CBS;

    // 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
        newColor = RED;

    setColor(packet, newColor);
    return newColor;
}

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

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

void inet::TokenBucketMeter::refreshDisplay ( ) const

overrideprotectedvirtual

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

Member Data Documentation

long inet::TokenBucketMeter::CBS = 0

protected

double inet::TokenBucketMeter::CIR = NaN

protected

bool inet::TokenBucketMeter::colorAwareMode = false

protected

simtime_t inet::TokenBucketMeter::lastUpdateTime

protected

int inet::TokenBucketMeter::numRcvd = 0

protected

int inet::TokenBucketMeter::numRed = 0

protected

long inet::TokenBucketMeter::Tc = 0

protected

---

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

• TokenBucketMeter.h
• TokenBucketMeter.cc