TimeBasedTokenGenerator

simple module

This module generates tokens for a TokenBasedServer repeatedly.

Inheritance diagram

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Extends

Name	Type	Description
TokenGeneratorBase	simple module	This is a base module for various token generator modules.

Parameters

Name	Type	Default value	Description
serverModule	string		module path of the packet server where the tokens are generated via C++ method call
displayStringTextFormat	string	"generated %t tk\nto %s"	determines display string text above the submodule
generationInterval	double		time interval between two subsequent token generation events
numTokens	double	1	number of tokens generated repeatedly

Properties

Name	Value	Description
class	TimeBasedTokenGenerator
display	i=block/control

Signals

Name	Type	Unit
tokensCreated	double

Statistics

Name	Title	Source	Record	Unit	Interpolation Mode
tokensCreated	tokens created		count, sum, vector		none

Source code

//
// This module generates tokens for a ~TokenBasedServer repeatedly.
//
simple TimeBasedTokenGenerator extends TokenGeneratorBase
{
    parameters:
        volatile double generationInterval @unit(s); // time interval between two subsequent token generation events
        volatile double numTokens = default(1); // number of tokens generated repeatedly
        @class(TimeBasedTokenGenerator);
        @display("i=block/control");
        @signal[tokensCreated](type=double);
        @statistic[tokensCreated](title="tokens created"; record=count,sum,vector; interpolationmode=none);
}

File: src/inet/queueing/tokengenerator/TimeBasedTokenGenerator.ned