Click or drag to resize

Throttler Class

This is preliminary documentation and is subject to change.

Used to throttle a sequence of incoming actions.
Inheritance Hierarchy
SystemObject
  WikiClientLibrary.InfrastructuresThrottler

Namespace: WikiClientLibrary.Infrastructures
Assembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.9.0-int.2+447d1d590e6726b7881f750a0a0e42908f3e417e
Syntax
Copy
public class Throttler : IWikiClientLoggable

The Throttler type exposes the following members.

Constructors
 NameDescription
Public methodThrottlerInitializes a new instance of the Throttler class
Top
Properties
 NameDescription
Public propertyCompletion Gets a task that is completed when all the queued work items up till now has been processed.
Public propertyLogger Replaces the logger factory of the specified instance.
Public propertyQueuedWorkCount Gets the count of current queued work, including the processing ones.
Public propertyThrottleTime The time to wait before each of the queued work to be performed.
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodQueueWorkAsync Asynchronously enqueues a work item.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Extension Methods
 NameDescription
Public Extension MethodBeginActionScope Invokes BeginScopeTState(TState) with the current action(method) name and parameters.
(Defined by WikiLoggingHelper)
Public Extension MethodBeginActionScope
(Defined by WikiLoggingHelper)
Public Extension MethodBeginActionScope Invokes BeginScopeTState(TState) on the Logger with the current action(method) name and parameters.
(Defined by WikiLoggingHelper)
Public Extension MethodBeginActionScope
(Defined by WikiLoggingHelper)
Public Extension MethodBeginActionScope Invokes BeginScopeTState(TState) on the Logger with the current action(method) name and parameters.
(Defined by WikiLoggingHelper)
Top
Remarks
The usage of throttler implies the forced serial operations.
See Also