Coral::BandwidthManager Class Reference

Bandwidth Manager. More...

#include <bandwidthmanager.h>

Inheritance diagram for Coral::BandwidthManager:

List of all members.

Public Member Functions
	BandwidthManager (ServiceLevelAgreement *sla, RoundTripTimePinger *rttp)
	~BandwidthManager ()
void	addStream (ManagedStreamInterface *stream, const cardinal sessionID=0, const char *name=NULL)
void	removeStream (ManagedStreamInterface *stream)
void	updateStream (ManagedStreamInterface *stream)
void	forceCompleteRemapping ()
void	intervalChangeEvent (ManagedStreamInterface *stream, const bool isNew, const card64 when, const bool newRUList)
void	reportEvent (ManagedStreamInterface *stream, const RTCPReceptionReportBlock *report, const cardinal layer)
void	bufferFlushEvent (ManagedStreamInterface *stream, const cardinal layer)
void	timerEvent ()
void	setLogStream (ostream *logStream)
void	getPartialRemapping (bool &enabled, double &reservedPortion, double &utilizationTolerance, double &maxRemappingInterval) const
void	setPartialRemapping (const bool enabled, const double reservedPortion, const double utilizationTolerance, const double maxRemappingInterval)
void	getFairness (double &fairnessSession, double &fairnessStream) const
void	setFairness (const double fairnessSession, const double fairnessStream)
void	getQoSOptimizationParameters (cardinal &maxRUPoints, double &utilizationThreshold, card64 &bandwidthThreshold, double &systemDelayTolerance, bool &unlayeredAllocation) const
void	setQoSOptimizationParameters (const cardinal maxRUPoints, const double utilizationThreshold, const card64 bandwidthThreshold, const double systemDelayTolerance, const bool unlayeredAllocation)
void	updateReservation (StreamDescription *streamDescription)
Public Attributes
card64	TotalAvailableBandwidth
card64	ClassAvailableBandwidthArray [TrafficClassValues::MaxValues]
card64	TotalBandwidth
card64	ClassBandwidthArray [TrafficClassValues::MaxValues]
int64	SLAUpdateRecommendation [TrafficClassValues::MaxValues]
card64	StreamIDGenerator
card64	LastCompleteRemapping
card64	LastCompleteRemappingDuration
cardinal	CompleteRemappings
cardinal	PartialRemappings
cardinal	TotalBufferFlushes
multimap < ManagedStreamInterface *, StreamDescription * >	StreamSet
multimap< cardinal, SessionDescription * >	SessionSet
ServiceLevelAgreement *	SLA
cardinal	Streams
cardinal	Sessions
cardinal	MaxRUPoints
double	UtilizationThreshold
card64	BandwidthThreshold
double	SystemDelayTolerance
double	FairnessSession
double	FairnessStream
double	AlphaLossRate
double	AlphaJitter
double	PartialRemappingPortion
double	PartialRemappingUtilizationTolerance
card64	MaxRemappingInterval
bool	EnablePartialRemappings
bool	UnlayeredAllocation
Static Public Attributes
static card64	SimulatorTime = 0
Private Member Functions
cardinal	calculateSessionMultiPoints (SessionDescription *session, const cardinal offset, const cardinal lastPoint, ResourceUtilizationMultiPoint *rumpList)
void	getRoundTripTimes (StreamDescription *sd)
double	getPriorityFactor (const int8 streamPriority) const
double	getResourcePart (const ResourceUtilizationSimplePoint &rup) const
double	getResourcePart (const ResourceUtilizationMultiPoint &rump) const
double	getStreamSortingValue (const ResourceUtilizationSimplePoint &rup) const
double	getSessionSortingValue (const ResourceUtilizationMultiPoint &rump) const
bool	tryAllocation (ResourceUtilizationMultiPoint &rump, const card64 bandwidthLimit=(card64)-1)
void	doAllocationTrials (ResourceUtilizationMultiPoint *rumpList, const cardinal points, const card64 bandwidthLimit=(card64)-1)
bool	doPartialRemapping (StreamDescription *streamDescription)
void	doCompleteRemapping ()
Static Private Member Functions
static void	smoothedUpdate (double &value, const double measured, const double alpha)
Private Attributes
RoundTripTimePinger *	RTTP
ostream *	Log
card64	LogStartupTimeStamp
bool	Changed

---

Detailed Description

Bandwidth Manager.

This is the bandwidth manager.

Author:

Thomas Dreibholz

Version:

1.0

---

Constructor & Destructor Documentation

Coral::BandwidthManager::BandwidthManager	(	ServiceLevelAgreement *	sla,
		RoundTripTimePinger *	rttp
	)

Constructor.

Parameters:

sla	ServiceLevelAgreement object.
rttp	RoundTripTimePinger object.

Coral::BandwidthManager::~BandwidthManager

(

)

Destructor.

---

Member Function Documentation

void Coral::BandwidthManager::addStream	(	ManagedStreamInterface *	stream,
		const cardinal	sessionID = 0,
		const char *	name = NULL
	)

Add stream to management.

Parameters:

stream	Stream to add.
session	SessionID of session to add stream to (0 for no session).
name	Stream name (only for log printing).

void Coral::BandwidthManager::bufferFlushEvent	(	ManagedStreamInterface *	stream,
		const cardinal	layer
	)

Buffer flush for a given layer.

Parameters:

stream

Stream.

cardinal Coral::BandwidthManager::calculateSessionMultiPoints	(	SessionDescription *	session,
		const cardinal	offset,
		const cardinal	lastPoint,
		ResourceUtilizationMultiPoint *	rumpList
	)		[private]

void Coral::BandwidthManager::doAllocationTrials	(	ResourceUtilizationMultiPoint *	rumpList,
		const cardinal	points,
		const card64	bandwidthLimit = (card64)-1
	)		[private]

void Coral::BandwidthManager::doCompleteRemapping

(

)

[private]

bool Coral::BandwidthManager::doPartialRemapping

(

StreamDescription *

streamDescription

)

[private]

void Coral::BandwidthManager::forceCompleteRemapping

(

)

[inline]

Force a complete remapping.

void Coral::BandwidthManager::getFairness	(	double &	fairnessSession,
		double &	fairnessStream
	)		const [inline]

Get fairnes settings.

Parameters:

fairnessSession	Reference to store session fairness.
fairnessStream	Reference to store stream fairness.

void Coral::BandwidthManager::getPartialRemapping	(	bool &	enabled,
		double &	reservedPortion,
		double &	utilizationTolerance,
		double &	maxRemappingInterval
	)		const [inline]

Get partial remapping parameters.

Parameters:

enabled	Reference to store true, if partial remappings are enabled; false otherwise.
reservedPortion	Reference to store reserved bandwidth portion (out of [0,1]).
utilizationTolerance	Reference to store utilization tolerance for partial remapping.
maxRemappingInterval	Reference to store maximum interval between two complete remappings.

double Coral::BandwidthManager::getPriorityFactor

(

const int8

streamPriority

)

const [inline, private]

void Coral::BandwidthManager::getQoSOptimizationParameters	(	cardinal &	maxRUPoints,
		double &	utilizationThreshold,
		card64 &	bandwidthThreshold,
		double &	systemDelayTolerance,
		bool &	unlayeredAllocation
	)		const [inline]

Get QoS optimization parameters.

Parameters:

maxRUPoints	Reference to store maximum number of RU points per stream.
utilizationThreshold	Reference to store utilization threshold.
bandwidthThreshold	Reference to store bandwidth threshold.
systemDelayTolerance	Reference to store the system's delay tolerance for the buffering optimization.

double Coral::BandwidthManager::getResourcePart

(

const ResourceUtilizationSimplePoint &

rup

)

const [inline, private]

double Coral::BandwidthManager::getResourcePart

(

const ResourceUtilizationMultiPoint &

rump

)

const [inline, private]

void Coral::BandwidthManager::getRoundTripTimes

(

StreamDescription *

sd

)

[private]

double Coral::BandwidthManager::getSessionSortingValue

(

const ResourceUtilizationMultiPoint &

rump

)

const [inline, private]

double Coral::BandwidthManager::getStreamSortingValue

(

const ResourceUtilizationSimplePoint &

rup

)

const [inline, private]

void Coral::BandwidthManager::intervalChangeEvent	(	ManagedStreamInterface *	stream,
		const bool	isNew,
		const card64	when,
		const bool	newRUList
	)

Interval has changed.

Parameters:

stream	Stream with changed interval.
isNew	true, if new interval has been reached; false otherwise.
when	Microseconds to next interval.
newRUList	true, if new resource/utiliztion list has been reached; false otherwise.

void Coral::BandwidthManager::removeStream

(

ManagedStreamInterface *

stream

)

Remove stream from management.

Parameters:

stream

Stream to remove.

void Coral::BandwidthManager::reportEvent	(	ManagedStreamInterface *	stream,
		const RTCPReceptionReportBlock *	report,
		const cardinal	layer
	)

Report reception for given layer.

Parameters:

stream	Stream.
report	Report.
layer	Layer.

void Coral::BandwidthManager::setFairness	(	const double	fairnessSession,
		const double	fairnessStream
	)		[inline]

Set fairnes settings.

Parameters:

fairnessSession	Session fairness.
fairnessStream	Stream fairness.

void Coral::BandwidthManager::setLogStream

(

ostream *

logStream

)

Set log stream.

Parameters:

logStream

Stream to write log information to; NULL to disable logging.

void Coral::BandwidthManager::setPartialRemapping	(	const bool	enabled,
		const double	reservedPortion,
		const double	utilizationTolerance,
		const double	maxRemappingInterval
	)		[inline]

Set partial remapping parameters.

Parameters:

enabled	true, if partial remappings are enabled; false otherwise.
reservedPortion	Reserved bandwidth portion (out of [0,1]).
utilizationTolerance	Utilization tolerance for partial remapping.
maxRemappingInterval	Maximum interval between two complete remappings.

void Coral::BandwidthManager::setQoSOptimizationParameters	(	const cardinal	maxRUPoints,
		const double	utilizationThreshold,
		const card64	bandwidthThreshold,
		const double	systemDelayTolerance,
		const bool	unlayeredAllocation
	)		[inline]

Set QoS optimization parameters.

Parameters:

maxRUPoints	Maximum number of RU points per stream.
utilizationThreshold	Utilization threshold.
bandwidthThreshold	Bandwidth threshold.
systemDelayTolerance	The system's delay tolerance for the buffering optimization.

static void Coral::BandwidthManager::smoothedUpdate	(	double &	value,
		const double	measured,
		const double	alpha
	)		[inline, static, private]

void Coral::BandwidthManager::timerEvent

(

)

[virtual]

Implementation of TimedThread's timerEvent() method.

See also:

TimedThread::timerEvent

Implements Coral::TimedThread.

bool Coral::BandwidthManager::tryAllocation	(	ResourceUtilizationMultiPoint &	rump,
		const card64	bandwidthLimit = (card64)-1
	)		[private]

void Coral::BandwidthManager::updateReservation

(

StreamDescription *

streamDescription

)

void Coral::BandwidthManager::updateStream

(

ManagedStreamInterface *

stream

)

Update stream.

Parameters:

stream

Stream to be updated.

---

Member Data Documentation

double Coral::BandwidthManager::AlphaJitter

double Coral::BandwidthManager::AlphaLossRate

card64 Coral::BandwidthManager::BandwidthThreshold

bool Coral::BandwidthManager::Changed [private]

card64 Coral::BandwidthManager::ClassAvailableBandwidthArray[TrafficClassValues::MaxValues]

card64 Coral::BandwidthManager::ClassBandwidthArray[TrafficClassValues::MaxValues]

cardinal Coral::BandwidthManager::CompleteRemappings

bool Coral::BandwidthManager::EnablePartialRemappings

double Coral::BandwidthManager::FairnessSession

double Coral::BandwidthManager::FairnessStream

card64 Coral::BandwidthManager::LastCompleteRemapping

card64 Coral::BandwidthManager::LastCompleteRemappingDuration

ostream* Coral::BandwidthManager::Log [private]

card64 Coral::BandwidthManager::LogStartupTimeStamp [private]

card64 Coral::BandwidthManager::MaxRemappingInterval

cardinal Coral::BandwidthManager::MaxRUPoints

double Coral::BandwidthManager::PartialRemappingPortion

cardinal Coral::BandwidthManager::PartialRemappings

double Coral::BandwidthManager::PartialRemappingUtilizationTolerance

RoundTripTimePinger* Coral::BandwidthManager::RTTP [private]

cardinal Coral::BandwidthManager::Sessions

multimap<cardinal,SessionDescription*> Coral::BandwidthManager::SessionSet

card64 Coral::BandwidthManager::SimulatorTime = 0 [static]

ServiceLevelAgreement* Coral::BandwidthManager::SLA

int64 Coral::BandwidthManager::SLAUpdateRecommendation[TrafficClassValues::MaxValues]

card64 Coral::BandwidthManager::StreamIDGenerator

cardinal Coral::BandwidthManager::Streams

multimap<ManagedStreamInterface*,StreamDescription*> Coral::BandwidthManager::StreamSet

double Coral::BandwidthManager::SystemDelayTolerance

card64 Coral::BandwidthManager::TotalAvailableBandwidth

card64 Coral::BandwidthManager::TotalBandwidth

cardinal Coral::BandwidthManager::TotalBufferFlushes

bool Coral::BandwidthManager::UnlayeredAllocation

double Coral::BandwidthManager::UtilizationThreshold

---

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

• bandwidthmanager.h
• bandwidthmanager.cc