Click or drag to resize

CancellationToken Class

Represents a token that can be used to cancel an asynchronous operation.
Inheritance Hierarchy
SystemObject
  GSF.ThreadingCancellationToken

Namespace: GSF.Threading
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.181-beta
Syntax
public class CancellationToken : ICancellationToken
View Source

The CancellationToken type exposes the following members.

Constructors
 NameDescription
Public methodCancellationTokenInitializes a new instance of the CancellationToken class
Top
Properties
 NameDescription
Public propertyIsCancelled Gets a value that indicates whether the operation has been cancelled.
Top
Methods
 NameDescription
Public methodCancel Cancels the operation.
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 methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventCancelled Event that will be raised when this CancellationToken is cancelled.
Top
Operators
 NameDescription
Public operatorStatic member(CancellationToken to CancellationToken) Implicitly converts a GSF cancellation token to an associated CancellationToken.
Public operatorStatic member(CancellationToken to CancellationTokenSource) Implicitly converts a GSF cancellation token to an associated CancellationTokenSource.
Top
Extension Methods
 NameDescription
Public Extension MethodGetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Top
See Also