inet::queueing::TokenBucketMixin< T > Class Template Reference

#include <TokenBucketMixin.h>

Inheritance diagram for inet::queueing::TokenBucketMixin< T >:

Public Member Functions
virtual	~TokenBucketMixin ()
virtual double	getNumTokens () const override
virtual void	addTokens (double numTokens) override
virtual void	removeTokens (double numTokens) override
virtual void	addTokenProductionRate (double tokenRate) override
virtual void	removeTokenProductionRate (double tokenRate) override
Public Member Functions inherited from inet::units::value< Value, Units >
	value ()
	value (const value_type &v)
template<typename OtherValue , typename OtherUnits >
	value (const value< OtherValue, OtherUnits > &v)
std::string	str () const
const value_type &	get () const
void	set (const value_type &v)
template<typename OtherValue , typename OtherUnits >
value &	operator= (const value< OtherValue, OtherUnits > &other)
template<typename OtherValue , typename OtherUnits , typename ResultValue = typename std::remove_cv<decltype(Value() + OtherValue())>::type>
value< ResultValue, Units >	operator+ (const value< OtherValue, OtherUnits > &other) const
template<typename OtherValue , typename OtherUnits >
value &	operator+= (const value< OtherValue, OtherUnits > &other)
template<typename OtherValue , typename OtherUnits >
value &	operator-= (const value< OtherValue, OtherUnits > &other)
template<typename OtherValue , typename OtherUnits , typename ResultValue = typename std::remove_cv<decltype(Value() - OtherValue())>::type>
value< ResultValue, Units >	operator- (const value< OtherValue, OtherUnits > &other) const
value	operator- () const
template<typename OtherValue , typename OtherUnits , typename ResultValue = typename std::remove_cv<decltype(Value() * OtherValue())>::type>
value< ResultValue, compose< Units, OtherUnits > >	operator* (const value< OtherValue, OtherUnits > &other) const
template<typename OtherValue >
value	operator* (OtherValue v) const
value &	operator*= (const value_type &v)
template<typename OtherValue , typename OtherUnits , typename ResultValue = typename std::remove_cv<decltype(Value() / OtherValue())>::type>
value< ResultValue, compose< Units, pow< OtherUnits, -1 > > >	operator/ (const value< OtherValue, OtherUnits > &other) const
value	operator/ (const value_type &v) const
value &	operator/= (const value_type &v)
template<typename OtherValue , typename OtherUnits >
bool	operator== (const value< OtherValue, OtherUnits > &other) const
template<typename OtherValue , typename OtherUnits >
bool	operator!= (const value< OtherValue, OtherUnits > &other) const
template<typename OtherValue , typename OtherUnits >
bool	operator< (const value< OtherValue, OtherUnits > &other) const
template<typename OtherValue , typename OtherUnits >
bool	operator<= (const value< OtherValue, OtherUnits > &other) const
template<typename OtherValue , typename OtherUnits >
bool	operator> (const value< OtherValue, OtherUnits > &other) const
template<typename OtherValue , typename OtherUnits >
bool	operator>= (const value< OtherValue, OtherUnits > &other) const
value &	operator++ ()
value	operator++ (int)
value &	operator-- ()
value	operator-- (int)
Public Member Functions inherited from inet::queueing::ITokenStorage
virtual	~ITokenStorage ()

Protected Member Functions
virtual void	initialize (int stage) override
virtual void	handleMessage (cMessage *message) override
virtual void	finish () override
const virtual char *	resolveDirective (char directive) const override
virtual void	rescheduleOverflowTimer ()

Protected Attributes
TokenBucket	tokenBucket
cMessage *	overflowTimer = nullptr

Additional Inherited Members
Public Types inherited from inet::units::value< Value, Units >
typedef Value	value_type
typedef Units	unit

Constructor & Destructor Documentation

~TokenBucketMixin()

template<typename T >

virtual inet::queueing::TokenBucketMixin< T >::~TokenBucketMixin ( )

inlinevirtual

{ T::cancelAndDelete(overflowTimer); }

Member Function Documentation

addTokenProductionRate()

template<typename T >

virtual void inet::queueing::TokenBucketMixin< T >::addTokenProductionRate ( double  tokenRate )

inlineoverridevirtual

Implements inet::queueing::ITokenStorage.

    {
        Enter_Method("addTokenProductionRate");
        EV_INFO << "Adding token production rate" << EV_FIELD(tokenRate) << EV_FIELD(tokenBucket) << EV_ENDL;
        tokenBucket.addTokenProductionRate(tokenRate);
        rescheduleOverflowTimer();
    }

addTokens()

template<typename T >

virtual void inet::queueing::TokenBucketMixin< T >::addTokens ( double  numTokens )

inlineoverridevirtual

Implements inet::queueing::ITokenStorage.

    {
        Enter_Method("addTokens");
        EV_INFO << "Adding tokens" << EV_FIELD(numTokens) << EV_FIELD(tokenBucket) << EV_ENDL;
        T::emit(tokensChangedSignal, getNumTokens());
        tokenBucket.addTokens(numTokens);
        T::emit(tokensChangedSignal, tokenBucket.getNumTokens());
        rescheduleOverflowTimer();
    }

finish()

template<typename T >

virtual void inet::queueing::TokenBucketMixin< T >::finish ( )

inlineoverrideprotectedvirtual

    {
        T::emit(tokensChangedSignal, getNumTokens());
    }

getNumTokens()

template<typename T >

virtual double inet::queueing::TokenBucketMixin< T >::getNumTokens ( ) const

inlineoverridevirtual

Implements inet::queueing::ITokenStorage.

    {
        return tokenBucket.getNumTokens();
    }

handleMessage()

template<typename T >

virtual void inet::queueing::TokenBucketMixin< T >::handleMessage ( cMessage *  message )

inlineoverrideprotectedvirtual

    {
        if (message == overflowTimer)
            // initiate overflow
            tokenBucket.getNumTokens();
        else
            throw cRuntimeError("Unknown message");
    }

initialize()

template<typename T >

virtual void inet::queueing::TokenBucketMixin< T >::initialize ( int  stage )

inlineoverrideprotectedvirtual

Reimplemented in inet::queueing::TokenBucketMeterMixin< TokenBucketMixin< PacketMeterBase > >, inet::queueing::TokenBucketMeter, inet::queueing::TokenBucketClassifierMixin< TokenBucketMixin< PacketClassifierBase > >, and inet::queueing::TokenBucketClassifier.

    {
        T::initialize(stage);
        if (stage == INITSTAGE_LOCAL) {
            double numTokens = T::par("initialNumTokens");
            double maxNumTokens = T::par("maxNumTokens");
            double tokenProductionRate = T::par("tokenProductionRate");
            auto excessTokenModule = findModuleFromPar<ITokenStorage>(T::par("excessTokenModule"), this);
            tokenBucket = TokenBucket(numTokens, maxNumTokens, tokenProductionRate, excessTokenModule);
            overflowTimer = new cMessage("OverflowTimer");
            WATCH(tokenBucket);
        }
        else if (stage == INITSTAGE_QUEUEING) {
            T::emit(tokensChangedSignal, getNumTokens());
            rescheduleOverflowTimer();
        }
    }

removeTokenProductionRate()

template<typename T >

virtual void inet::queueing::TokenBucketMixin< T >::removeTokenProductionRate ( double  tokenRate )

inlineoverridevirtual

Implements inet::queueing::ITokenStorage.

    {
        Enter_Method("removeTokenProductionRate");
        EV_INFO << "Removing token production rate" << EV_FIELD(tokenRate) << EV_FIELD(tokenBucket) << EV_ENDL;
        tokenBucket.removeTokenProductionRate(tokenRate);
        rescheduleOverflowTimer();
    }

removeTokens()

template<typename T >

virtual void inet::queueing::TokenBucketMixin< T >::removeTokens ( double  numTokens )

inlineoverridevirtual

Implements inet::queueing::ITokenStorage.

    {
        Enter_Method("removeTokens");
        EV_INFO << "Removing tokens" << EV_FIELD(numTokens) << EV_FIELD(tokenBucket) << EV_ENDL;
        T::emit(tokensChangedSignal, getNumTokens());
        tokenBucket.removeTokens(numTokens);
        T::emit(tokensChangedSignal, tokenBucket.getNumTokens());
        rescheduleOverflowTimer();
    }

rescheduleOverflowTimer()

template<typename T >

virtual void inet::queueing::TokenBucketMixin< T >::rescheduleOverflowTimer ( )

inlineprotectedvirtual

                                           {
        if (tokenBucket.getExcessTokenStorage() != nullptr && tokenBucket.getOverflowTime() > simTime())
            T::rescheduleAt(tokenBucket.getOverflowTime(), overflowTimer);
    }

resolveDirective()

template<typename T >

const virtual char* inet::queueing::TokenBucketMixin< T >::resolveDirective ( char  directive ) const

inlineoverrideprotectedvirtual

    {
        static std::string result;
        switch (directive) {
            case 'n': {
                std::stringstream stream;
                stream << tokenBucket.getNumTokens();
                result = stream.str();
                break;
            }
            default:
                return T::resolveDirective(directive);
        }
        return result.c_str();
    }

Member Data Documentation

overflowTimer

template<typename T >

cMessage* inet::queueing::TokenBucketMixin< T >::overflowTimer = nullptr

protected

tokenBucket

template<typename T >

TokenBucket inet::queueing::TokenBucketMixin< T >::tokenBucket

protected

---

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

• TokenBucketMixin.h