ThrPutMeter Class Reference

#include <ThrPutMeter.h>

Inheritance diagram for ThrPutMeter:

List of all members.

Public Member Functions
virtual double	getCurBitRate ()
Protected Member Functions
virtual void	updateStats (simtime_t now, unsigned long bits)
virtual void	beginNewInterval (simtime_t now)
virtual void	initialize ()
virtual void	handleMessage (cMessage *msg)
virtual void	finish ()
Protected Attributes
simtime_t	startTime
unsigned int	batchSize
simtime_t	maxInterval
unsigned long	numPackets
unsigned long	numBits
simtime_t	intvlStartTime
simtime_t	intvlLastPkTime
unsigned long	intvlNumPackets
unsigned long	intvlNumBits
cOutVector	bitpersecVector
cLongHistogram	bitpersecStats
cOutVector	pkpersecVector
cLongHistogram	pkpersecStats
double	curBitRate

---

Detailed Description

Measures and records network thruput

---

Member Function Documentation

void ThrPutMeter::beginNewInterval

(

simtime_t

now

)

[protected, virtual]

{
    simtime_t duration = now - intvlStartTime;

    // record measurements
    double bitpersec = intvlNumBits/duration.dbl();
    double pkpersec = intvlNumPackets/duration.dbl();
    curBitRate = intvlNumBits/duration.dbl();

    //Record vector
    bitpersecVector.recordWithTimestamp(intvlStartTime, bitpersec);
    //Record vector statistics
    bitpersecStats.collect(bitpersec);
    //Record vector
    pkpersecVector.recordWithTimestamp(intvlStartTime, pkpersec);
    //Record vector statistics
    pkpersecStats.collect(pkpersec);

    // restart counters
    intvlStartTime = now;  // FIXME this should be *beginning* of tx of this packet, not end!
    intvlNumPackets = intvlNumBits = 0;
}

void ThrPutMeter::finish

(

)

[protected, virtual]

Reimplemented from cComponent.

{
    simtime_t duration = simTime() - startTime;

    recordScalar("duration", duration);
    recordScalar("total packets", numPackets);
    recordScalar("total bits", numBits);

    recordScalar("avg throughput (bit/s)", numBits/duration.dbl());
    bitpersecStats.recordAs("throughput (bit/sec)");
    recordScalar("avg packets/s", numPackets/duration.dbl());
    pkpersecStats.recordAs("packets/sec");
}

virtual double ThrPutMeter::getCurBitRate

(

)

[inline, virtual]

{return curBitRate;}

void ThrPutMeter::handleMessage

(

cMessage *

msg

)

[protected, virtual]

Reimplemented from cSimpleModule.

{
        //If the received message is the scheduled message for counting the metrics
        if (msg->isSelfMessage()) {
                //Start a new measuring interval
                beginNewInterval(simTime());

                //Reschedule reporting self message
                simtime_t intvl = par("maxInterval").doubleValue();
                scheduleAt(simTime()+intvl, msg);
        }
        //Else record the packets coming through the Throughput Meter
        else {
                updateStats(simTime(), PK(msg)->getBitLength());
                send(msg, "out");
        }
}

void ThrPutMeter::initialize

(

)

[protected, virtual]

Reimplemented from cComponent.

{
    startTime = par("startTime");
    long _batchSize = par("batchSize");
    if((_batchSize < 0) || (((long)(unsigned int)_batchSize) != _batchSize))
        throw cRuntimeError("invalid 'batchSize=%ld' parameter at '%s' module",_batchSize, getFullPath().c_str());
    batchSize = (unsigned int)_batchSize;
    maxInterval = par("maxInterval");

    numPackets = numBits = 0;
    intvlStartTime = intvlLastPkTime = 0;
    intvlNumPackets = intvlNumBits = 0;

    WATCH(numPackets);
    WATCH(numBits);
    WATCH(intvlStartTime);
    WATCH(intvlNumPackets);
    WATCH(intvlNumBits);

    //Create self message for metric estimation
    cMessage *record = new cMessage("Record");
        simtime_t intvl = par("maxInterval").doubleValue();
        scheduleAt(simTime()+intvl, record);

    bitpersecVector.setName("throughput (bit/sec)");
    pkpersecVector.setName("packet/sec");
}

void ThrPutMeter::updateStats	(	simtime_t	now,
		unsigned long	bits
	)			[protected, virtual]

{
    numPackets++;
    numBits += bits;
    intvlNumPackets++;
    intvlNumBits += bits;
    intvlLastPkTime = now;
}

---

Member Data Documentation

unsigned int ThrPutMeter::batchSize [protected]

cLongHistogram ThrPutMeter::bitpersecStats [protected]

cOutVector ThrPutMeter::bitpersecVector [protected]

double ThrPutMeter::curBitRate [protected]

simtime_t ThrPutMeter::intvlLastPkTime [protected]

unsigned long ThrPutMeter::intvlNumBits [protected]

unsigned long ThrPutMeter::intvlNumPackets [protected]

simtime_t ThrPutMeter::intvlStartTime [protected]

simtime_t ThrPutMeter::maxInterval [protected]

unsigned long ThrPutMeter::numBits [protected]

unsigned long ThrPutMeter::numPackets [protected]

cLongHistogram ThrPutMeter::pkpersecStats [protected]

cOutVector ThrPutMeter::pkpersecVector [protected]

simtime_t ThrPutMeter::startTime [protected]

---

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

• ThrPutMeter.h
• ThrPutMeter.cc