| TokenBucketOffer Method |
Call this (side-effecting) method whenever an element should be passed through the token-bucket. This method
will return the number of nanoseconds the element needs to be delayed to conform with the token bucket parameters.
Returns zero if the element can be emitted immediately. The method does not handle overflow, if an element is to
be delayed longer in nanoseconds than what can be represented as a positive Long then an undefined value is returned.
If a non-zero value is returned, it is the responsibility of the caller to not call this method before the
returned delay has been elapsed (but can be called later). This class does not check or protect against early
calls.
Namespace:
Akka.Util
Assembly:
Akka (in Akka.dll) Version: 1.2.3.42 (1.2.3.42)
Syntax public long Offer(
long cost
)
member Offer :
cost : int64 -> int64
Parameters
- cost
- Type: SystemInt64
How many tokens the element costs. Can be larger than the capacity of the bucket.
Return Value
Type:
Int64TBD
Exceptions Exception | Condition |
---|
ArgumentException |
This exception is thrown when the specified cost is less than zero.
|
See Also