Class StopToken

Namespace

Hi.Native

Assembly

HiDisp.dll

Represents a token that can be used to request cancellation of operations.

public class StopToken : IDisposable

Inheritance

object

StopToken

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])

InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)

InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)

ColorUtil.GetGloomyColor(object, double, double)

NameUtil.GetSelectionName(object)

StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)

LockUtil.Lock(object)

Constructors

StopToken(nint, bool)

Initializes a new instance of the StopToken class.

public StopToken(nint stopTokenPtr, bool isDisposable)

Parameters

stopTokenPtr nint

Pointer to the native stop token

isDisposable bool

Specifies whether this token should be disposed by managed code:

• Set to false if the pointer is created by C++ (disposal handled by native code)
• Set to true if the pointer is created by StopSource.GetStopToken() (disposal handled by managed code)

Properties

StopTokenPtr

Gets the pointer to the native stop token.

public nint StopTokenPtr { get; }

Property Value

nint

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Dispose(bool)

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

~StopToken()

Finalizer for the StopToken class.

protected ~StopToken()

IsStopPossible()

Checks if stopping is possible for this token.

public bool IsStopPossible()

Returns

bool

True if stopping is possible; otherwise, false.

IsStopRequested()

Checks if stopping has been requested for this token.

public bool IsStopRequested()

Returns

bool

True if stopping has been requested; otherwise, false.