RateLimiter Class

A rate limiting system based on tokes.

Inheritance Hierarchy

SystemObject
GSF.ThreadingRateLimiter

Namespace: GSF.Threading
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.257-beta+00aa2366fbb9ec75f636ebc7cfa610e3826a727c

Syntax

public class RateLimiter

Public Class RateLimiter

public ref class RateLimiter

type RateLimiter = class end

GSF.Threading.RateLimiter = function();

Type.createClass(
	'GSF.Threading.RateLimiter');

The RateLimiter type exposes the following members.

Constructors

	Name	Description
	RateLimiter	Creates a RateLimiter

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ToString	Returns a string that represents the current object. (Inherited from Object)
	TryTakeToken	Attempts to take a token from the rate limiter.
	UpdateLimits	Updates the limits associated with this rate limiter. Note, after this update, the tokens will be completely resupplied.

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)