Limits Squid-to-client bandwidth for each matching response. More...

#include <MessageBucket.h>

Inheritance diagram for MessageBucket:

Collaboration diagram for MessageBucket:

Public Types
typedef RefCount< MessageBucket >	Pointer

Public Member Functions
	MessageBucket (const int speed, const int initialLevelPercent, const double sizeLimit, MessageDelayPool::Pointer pool)

int	quota () override

void	scheduleWrite (Comm::IoCallback *state) override
	Will plan another write call.

void	reduceBucket (int len) override
	Decreases the bucket level.

virtual bool	applyQuota (int &nleft, Comm::IoCallback *state)

virtual void	onFdClosed ()
	Performs cleanup when the related file descriptor becomes closed.

bool	noLimit () const
	Whether this bucket will not do bandwidth limiting.

Static Public Member Functions
static BandwidthBucket *	SelectBucket (fde *f)

Public Attributes
double	bucketLevel
	how much can be written now

bool	selectWaiting
	is between commSetSelect and commHandleWrite

Protected Member Functions
void	refillBucket ()
	Increases the bucket level with the writeSpeedLimit speed.

Protected Attributes
double	prevTime
	previous time when we checked

double	writeSpeedLimit
	Write speed limit in bytes per second.

double	bucketSizeLimit
	maximum bucket size

Private Member Functions
	MEMPROXY_CLASS (MessageBucket)

Private Attributes
MessageDelayPool::Pointer	theAggregate

Detailed Description

Definition at line 20 of file MessageBucket.h.

Member Typedef Documentation

◆ Pointer

typedef RefCount<MessageBucket> MessageBucket::Pointer

Definition at line 25 of file MessageBucket.h.

Constructor & Destructor Documentation

◆ MessageBucket()

MessageBucket::MessageBucket	(	const int	speed,
		const int	initialLevelPercent,
		const double	sizeLimit,
		MessageDelayPool::Pointer	pool
	)

Definition at line 17 of file MessageBucket.cc.

Member Function Documentation

◆ applyQuota()

bool BandwidthBucket::applyQuota	(	int &	nleft,
		Comm::IoCallback *	state
	)

virtualinherited

Adjusts nleft to not exceed the current bucket quota value, if needed.

Reimplemented in ClientInfo.

Definition at line 66 of file BandwidthBucket.cc.

References Comm::IoCallback::conn, debugs, min(), and BandwidthBucket::quota().

Referenced by ClientInfo::applyQuota().

◆ MEMPROXY_CLASS()

MessageBucket::MEMPROXY_CLASS ( MessageBucket )

private

◆ noLimit()

bool BandwidthBucket::noLimit ( ) const

inlineinherited

Definition at line 41 of file BandwidthBucket.h.

References BandwidthBucket::writeSpeedLimit.

Referenced by quota(), BandwidthBucket::reduceBucket(), and BandwidthBucket::refillBucket().

◆ onFdClosed()

virtual void BandwidthBucket::onFdClosed ( )

inlinevirtualinherited

Reimplemented in ClientInfo.

Definition at line 37 of file BandwidthBucket.h.

References BandwidthBucket::selectWaiting.

Referenced by ClientInfo::onFdClosed().

◆ quota()

int MessageBucket::quota ( )

overridevirtual

Returns: the number of bytes this bucket allows to write, also considering aggregates, if any. Negative quota means no limitations by this bucket.

Implements BandwidthBucket.

Definition at line 23 of file MessageBucket.cc.

References BandwidthBucket::bucketLevel, MessageDelayPool::level(), min(), BandwidthBucket::noLimit(), MessageDelayPool::noLimit(), BandwidthBucket::refillBucket(), MessageDelayPool::refillBucket(), and theAggregate.

Referenced by checkTimeouts().