OpenMetaverse Protocol Library Developers API Documentation
TokenBucket Class
NamespacesOpenMetaverseTokenBucket
A hierarchical token bucket for bandwidth throttling. See http://en.wikipedia.org/wiki/Token_bucket for more information
Declaration Syntax
C#
public 
class 
TokenBucket
Members
All Members Constructors Methods Properties



Icon Member Description
TokenBucket(TokenBucket, Int32, Int32)
Default constructor

Content
The number of bytes that can be sent at this moment. This is the current number of tokens in the bucket
Remarks
If this bucket has a parent bucket that does not have enough tokens for a request, will return false regardless of the content of this bucket

DripRate
The speed limit of this bucket in bytes per second. This is the number of tokens that are added to the bucket per second

MaxBurst
Maximum burst rate in bytes per second. This is the maximum number of tokens that can accumulate in the bucket at any one time

Parent
The parent bucket of this bucket, or null if this bucket has no parent. The parent bucket will limit the aggregate bandwidth of all of its children buckets

RemoveTokens(Int32)
Remove a given number of tokens from the bucket

RemoveTokens(Int32, Boolean % )
Remove a given number of tokens from the bucket

Inheritance Hierarchy
Object
TokenBucket

Assembly: OpenMetaverseTypes(Module: OpenMetaverseTypes.dll) Version: 0.0.0.0