Ieee8021qCreditBasedShaper

compound module

Implements the IEEE 802.1Q credit-based shaper.

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

Name	Type	Description
Ieee8021qCreditBasedGate	simple module	A packet gate that can be used to implement the IEEE 802.1q credit-based shaper algorithm in combination with a packet queue.

Name	Type	Default value	Description
displayStringTextFormat	string	"contains {currentCredit} cr, rate {currentCreditGainRate} crps\nserved %p pk (%l)"	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
bitrate	double	nan bps
extraLength	int	0b
extraDuration	double	0s
idleCreditGainRate	double	dropUnit(idleSlope)	Rate of credit increase while the packets that passed through this gate don't use the physical channel
transmitCreditSpendRate	double	-dropUnit(sendSlope)	Rate of credit decrease while the packets that passed through this gate use the physical channel
initialCredit	double	0	Initial number of credits
transmitCreditLimit	double	0	Credit limit above which the gate is open
minCredit	double	-inf	Minimum number of credits
maxCredit	double	dropUnit(maxInterferenceSize) * dropUnit(idleSlope / bitrate)	Maximum number of credits
accumulateCreditInGuardBand	bool	false	Whether credit increases during implicit guard band when no packets can be sent anymore
idleSlope	double		Data rate of the accumulated credits when the transmission channel is idle
sendSlope	double	idleSlope - bitrate	Data rate of the spent credits when the transmission channel is in use
maxInterferenceSize	double	inf b

Name	Value	Description
class	CreditBasedGate
display	i=block/cogwheel

Name	Direction	Size	Description
in	input
out	output

Name	Type	Unit	Description
creditsChanged	double

Name	Title	Source	Record	Unit	Interpolation Mode	Description
numCredits	number of credits	creditsChanged	vector	cr	linear

//
// Implements the IEEE 802.1Q credit-based shaper.
//
module Ieee8021qCreditBasedShaper extends Ieee8021qCreditBasedGate
{
}