Throttle Members

NFX Class Library

[This is preliminary documentation and is subject to change.]

The Throttle type exposes the following members.

Constructors

	Name	Description
	Throttle	Initializes a new instance of the Throttle class
	Throttle(String, String)	Constructor that identifies throttle by name, and optionally defines the unit of measurement for this throttle instance

Methods

	Name	Description
	__setComponentDirector	(Inherited from ApplicationComponent.)
	__setThrottling
	Configure
	Destructor	(Overrides ApplicationComponent Destructor .)
	Dispose	Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead (Inherited from DisposableObject.)
	DoConfigure
	EnsureObjectNotDisposed	Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called (Inherited from DisposableObject.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	(Inherited from DisposableObject.)
	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.)
	Register	Register this instance with throttling container
	Reset	Reset the internal state of the throttle
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Try	Checks whether the current throttle rate limit has not been reached per one unit of measurement. This method is usually used to throttle based on pass count
	Try(Double)	Checks whether the current throttle rate limit has not been reached for the provided value. This method is usually used to throttle based on values like financial amounts, data volumes, user counts, etc.
	Try(DateTime, Double)	Update current throttle timestamp
	Unregister	Unregister this instance from throttling container

Extension Methods

	Name	Description
	AsBool	(Defined by ObjectValueConversion.)
	AsByte	(Defined by ObjectValueConversion.)
	AsChar	(Defined by ObjectValueConversion.)
	AsDateTime	Overloaded. (Defined by ObjectValueConversion.)
	AsDateTime(DateTime, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsDecimal	(Defined by ObjectValueConversion.)
	AsDouble	(Defined by ObjectValueConversion.)
	AsEnum TEnum	(Defined by ObjectValueConversion.)
	AsFloat	(Defined by ObjectValueConversion.)
	AsGDID	Overloaded. (Defined by ObjectValueConversion.)
	AsGDID(GDID, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsGDIDSymbol	Overloaded. (Defined by ObjectValueConversion.)
	AsGDIDSymbol(GDIDSymbol, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsGUID	(Defined by ObjectValueConversion.)
	AsInt	(Defined by ObjectValueConversion.)
	AsJSONConfig	(Defined by ObjectValueConversion.)
	AsLaconicConfig	(Defined by ObjectValueConversion.)
	AsLong	(Defined by ObjectValueConversion.)
	AsNonNullOrEmptyString	(Defined by ObjectValueConversion.)
	AsNullableBool	(Defined by ObjectValueConversion.)
	AsNullableByte	(Defined by ObjectValueConversion.)
	AsNullableChar	(Defined by ObjectValueConversion.)
	AsNullableDateTime	(Defined by ObjectValueConversion.)
	AsNullableDecimal	(Defined by ObjectValueConversion.)
	AsNullableDouble	(Defined by ObjectValueConversion.)
	AsNullableEnum TEnum	(Defined by ObjectValueConversion.)
	AsNullableFloat	(Defined by ObjectValueConversion.)
	AsNullableGDID	(Defined by ObjectValueConversion.)
	AsNullableGDIDSymbol	(Defined by ObjectValueConversion.)
	AsNullableGUID	(Defined by ObjectValueConversion.)
	AsNullableInt	(Defined by ObjectValueConversion.)
	AsNullableLong	(Defined by ObjectValueConversion.)
	AsNullableSByte	(Defined by ObjectValueConversion.)
	AsNullableShort	(Defined by ObjectValueConversion.)
	AsNullableTimeSpan	(Defined by ObjectValueConversion.)
	AsNullableUInt	(Defined by ObjectValueConversion.)
	AsNullableULong	(Defined by ObjectValueConversion.)
	AsNullableUShort	(Defined by ObjectValueConversion.)
	AsSByte	(Defined by ObjectValueConversion.)
	AsShort	(Defined by ObjectValueConversion.)
	AsString	(Defined by ObjectValueConversion.)
	AsTimeSpan	Overloaded. (Defined by ObjectValueConversion.)
	AsTimeSpan(TimeSpan, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsUInt	(Defined by ObjectValueConversion.)
	AsULong	(Defined by ObjectValueConversion.)
	AsUri	(Defined by ObjectValueConversion.)
	AsUShort	(Defined by ObjectValueConversion.)
	AsXMLConfig	(Defined by ObjectValueConversion.)
	ToErlObject	Overloaded. Try to convert .NET native object type to corresponding Erlang term. Throw exception if conversion is not possible (Defined by ErlObject.)
	ToErlObject(ErlTypeOrder, Boolean)	Overloaded. Try to convert .NET native object type to corresponding Erlang term of given type. Throw exception if conversion is not possible (Defined by ErlObject.)
	ToJSON(JSONWritingOptions)	Overloaded. Serializes object into JSON string (Defined by JSONExtensions.)
	ToJSON(TextWriter, JSONWritingOptions)	Overloaded. Serializes object into JSON format using provided TextWriter (Defined by JSONExtensions.)
	ToJSON(Stream, JSONWritingOptions, Encoding)	Overloaded. Serializes object into JSON format using provided stream and optional encoding (Defined by JSONExtensions.)

Fields

	Name	Description
	DEFAULT_UNITS

Properties

	Name	Description
	ComponentCommonName	Returns the common name used to identify the component, for example "Glue" for various IGlue implementations. This name is searched-by some management tools that allow to find component by this name that does not change between application restarts like ComponentSID does. Subordinate (non-root) components return null (Inherited from ApplicationComponent.)
	ComponentDirector	Returns a reference to an object that this app component services/operates under, or null (Inherited from ApplicationComponent.)
	ComponentSID	Returns process/instance unique app component system id (Inherited from ApplicationComponent.)
	ComponentStartTime	Returns local computer time of component start (not from application container time) (Inherited from ApplicationComponent.)
	Disposed	Indicates whether this object was already disposed - the Dispose() has finished (Inherited from DisposableObject.)
	DisposeStarted	Indicates whether this object Dispose() has been called and dispose started but not finished yet (Inherited from DisposableObject.)
	Name	Returns the unique name of this instance
	Throttling	References the Throttling that this instance is registered with
	Unit	Returns the name of unit of measurement for this instance