PAM Resource Consumers

Consumer Name
(PAM Handler/Juggler Type)

Consumer Description

throttleBytesPerMinute

This is a PAM handler/juggler that measures the byte size of the products that pass through it. If the budgeted allocation or the pools budget is exceeded the throttle will delay passing new products to maintain the average below the budget.

PAM Resource Pools

Pool Name
(PAM Daemon Type)

Pool Description

bytesPerMinuteResourcePool

Maintains the budget and tracks current usage of bytes per minute for all throttleBytesPerMinute consumers

Attributes for bytesPerMinuteResourcePool

Attribute name

Writing its Value

Reading its Value

bytesPerMinuteBudget

Sets the new budget. This amount will not be exceeded on average by all the consumers in the pool

Implements the setBudget() model function

Gets the existing budget

Implements the getBudget() model function.

bytesPerMinuteConsumption

Establishes this value as the new "historical" consumption rate.

Implements the setConsumption() model function

Gets current historical moving average of bytesPerMinute that reflects the consumption of all consumers in the pool.

Implements the getConsumption() model function.

bytesPerMinuteManager

Has no effect. Readonly (for now)

Implements the setManager() model function.

Returns the name of the default (and only) manager.

Attributes for throttleBytesPerMinute

Attribute name

Writing its Value

Reading its Value

bytesPerMinutePoolId

Associates this consumer with it's internal PAM pool. If the pool does not exist it will be created as a side effect.

Returns the name of the associated pool.

useBytesPerMinutePoolWeight

Defaults to "false"

"true" means that the bytesPerMinutePoolWeight value will be used in allocating the pools total budget to the individual pool consumers.

"false" means that individual pool consumers use bandwidth on a first come first served basis (within the total pool budget)

Implements setConsumerConstraint() model function.

Returns current setting.

bytesPerMinutePoolWeight

Default is "1.0"

A number who's weight relative to other instances of this Handler indicates how much of the total pool's budget will be allocated to this instance.

If all members of a pool have the same weight then they all share the pools budget equally.

Implements setConsumerConstraint() model function.

Returns the current weight.

bytesPerMinuteConsumption

Establishes this value as the new "historical" consumption rate.

Implements the setConsumption() model function

Gets current historical moving average of bytesPerMinute that reflects the consumption of all consumers in the pool.

Implements the getConsumption() model function.