CancellationToken Class

Represents a token that can be used to cancel an asynchronous operation.

Definition

Namespace: Gemstone.Threading.Cancellation
Assembly: Gemstone.Common (in Gemstone.Common.dll) Version: 1.0.166 -- Release Build+d3cb24a90fe44346300dfbb17444d7b350f42d79

C#View Source Request Example

public class CancellationToken : ICancellationToken

VBView Source Request Example

Public Class CancellationToken
	Implements ICancellationToken

C++View Source Request Example

public ref class CancellationToken : ICancellationToken

JavaScriptView Source Request Example

Gemstone.Threading.Cancellation.CancellationToken = function();

Type.createClass(
	'Gemstone.Threading.Cancellation.CancellationToken',
	null,
	Gemstone.Threading.Cancellation.ICancellationToken);

Inheritance: Object CancellationToken

Implements: ICancellationToken

Constructors

CancellationToken

Initializes a new instance of the CancellationToken class

Properties

IsCancelled

Gets a value that indicates whether the operation has been cancelled.

Methods

Cancel	Cancels the operation.
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)

Events

Cancelled

Event that will be raised when this CancellationToken is cancelled.

Operators

(CancellationToken to CancellationToken)	Implicitly converts a GSF cancellation token to an associated CancellationToken.
(CancellationToken to CancellationTokenSource)	Implicitly converts a GSF cancellation token to an associated CancellationTokenSource.

Extension Methods

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)