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.218-beta+101eee949414e414795e55a6e73d88938f0177b8

Syntax

public class CancellationToken : ICancellationToken

Public Class CancellationToken
	Implements ICancellationToken

public ref class CancellationToken : ICancellationToken

type CancellationToken = 
    class
        interface ICancellationToken
    end

GSF.Threading.CancellationToken = function();

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

The CancellationToken type exposes the following members.

Constructors

	Name	Description
	CancellationToken	Initializes a new instance of the CancellationToken class

Properties

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

Methods

	Name	Description
	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

	Name	Description
	Cancelled	Event that will be raised when this CancellationToken is cancelled.

Operators

	Name	Description
	(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

	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)