System::Threading::CancellationTokenSource Class Reference
A cancellation token source that can be used to trigger cancellation notifications. More...
#include <cancellation_token_source.h>
Inherits System::IDisposable.
Public Member Functions | |
| CancellationTokenSource () | |
| Constructs a new CancellationTokenSource. More... | |
| bool | get_IsCancellationRequested () const |
| Gets whether cancellation has been requested. More... | |
| CancellationToken | get_Token () const |
| Gets the cancellation token associated with this source. More... | |
| void | Cancel () |
| Communicates a request for cancellation. More... | |
| void | Dispose () override |
| Releases all resources used by the CancellationTokenSource. More... | |
| virtual void | Dispose () |
| Does nothing. More... | |
 Public Member Functions inherited from System::Object | |
| Object () | |
| Creates object. Initializes all internal data structures. More... | |
| virtual | ~Object () |
| Destroys object. Frees all internal data structures. More... | |
| Object (Object const &x) | |
| Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More... | |
| Object & | operator= (Object const &x) |
| Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More... | |
| Object * | SharedRefAdded () |
| Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More... | |
| int | SharedRefRemovedSafe () |
| Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More... | |
| int | RemovedSharedRefs (int count) |
| Decreases shared reference count by specified value. More... | |
| Detail::SmartPtrCounter * | WeakRefAdded () |
| Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More... | |
| void | WeakRefRemoved () |
| Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More... | |
| Detail::SmartPtrCounter * | GetCounter () |
| Gets reference counter data structure associated with the object. More... | |
| int | SharedCount () const |
| Gets current value of shared reference counter. More... | |
| void | Lock () |
| Implements C# lock() statement locking. Call directly or use LockContext sentry object. More... | |
| void | Unlock () |
| Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More... | |
| virtual bool | Equals (ptr obj) |
| Compares objects using C# Object.Equals semantics. More... | |
| virtual int32_t | GetHashCode () const |
| Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More... | |
| virtual String | ToString () const |
| Analog of C# Object.ToString() method. Enables converting custom objects to string. More... | |
| virtual ptr | MemberwiseClone () const |
| Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More... | |
| virtual const TypeInfo & | GetType () const |
| Gets actual type of object. Analog of C# System.Object.GetType() call. More... | |
| virtual bool | Is (const TypeInfo &targetType) const |
| Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More... | |
| virtual void | SetTemplateWeakPtr (uint32_t argument) |
| Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More... | |
| virtual bool | FastCast (const Details::FastRttiBase &helper, void **out_ptr) const |
| For internal purposes only. More... | |
| template<> | |
| bool | ReferenceEquals (String const &str, std::nullptr_t) |
| Specialization of Object::ReferenceEquals for case of string and nullptr. More... | |
| template<> | |
| bool | ReferenceEquals (String const &str1, String const &str2) |
| Specialization of Object::ReferenceEquals for case of strings. More... | |
Static Public Member Functions | |
| static SharedPtr< CancellationTokenSource > | CreateLinkedTokenSource (const CancellationToken &token1, const CancellationToken &token2) |
| Creates a linked token source that cancels when any of the provided tokens cancel. More... | |
| Static Public Member Functions inherited from System::Object | |
| static bool | ReferenceEquals (ptr const &objA, ptr const &objB) |
| Compares objects by reference. More... | |
| template<typename T > | |
| static std::enable_if<!IsSmartPtr< T >::value, bool >::type | ReferenceEquals (T const &objA, T const &objB) |
| Compares objects by reference. More... | |
| template<typename T > | |
| static std::enable_if<!IsSmartPtr< T >::value, bool >::type | ReferenceEquals (T const &objA, std::nullptr_t) |
| Reference-compares value type object with nullptr. More... | |
| template<typename T1 , typename T2 > | |
| static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type | Equals (T1 const &objA, T2 const &objB) |
| Compares reference type objects in C# style. More... | |
| template<typename T1 , typename T2 > | |
| static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type | Equals (T1 const &objA, T2 const &objB) |
| Compares value type objects in C# style. More... | |
| static const TypeInfo & | Type () |
| Implements C# typeof(System.Object) construct. More... | |
| template<> | |
| bool | Equals (float const &objA, float const &objB) |
| Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More... | |
| template<> | |
| bool | Equals (double const &objA, double const &objB) |
| Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More... | |
Additional Inherited Members | |
| Public Types inherited from System::Object | |
| typedef SmartPtr< Object > | ptr |
| Alias for smart pointer type. More... | |
Detailed Description
A cancellation token source that can be used to trigger cancellation notifications.
Provides mechanisms to create and control cancellation tokens for cooperative cancellation of operations.
Constructor & Destructor Documentation
◆ CancellationTokenSource()
| System::Threading::CancellationTokenSource::CancellationTokenSource | ( | ) |
Constructs a new CancellationTokenSource.
- Postcondition
- Creates a token source in non-canceled state.
Member Function Documentation
◆ Cancel()
| void System::Threading::CancellationTokenSource::Cancel | ( | ) |
Communicates a request for cancellation.
- Postcondition
- All registered callbacks will be invoked.
- Subsequent calls to get_IsCancellationRequested() will return true.
- Note
- Callbacks are executed synchronously during this call.
◆ CreateLinkedTokenSource()
|
static |
Creates a linked token source that cancels when any of the provided tokens cancel.
- Parameters
-
token1 First cancellation token to monitor. token2 Second cancellation token to monitor.
- Returns
- New token source that will cancel when either input token cancels.
- Remarks
- The returned source will immediately cancel if either input token is already canceled.
◆ Dispose()
|
overridevirtual |
Releases all resources used by the CancellationTokenSource.
Unregisters all callbacks and makes the token unusable.
- Note
- Multiple calls are safe and have no additional effect.
Reimplemented from System::IDisposable.
◆ get_IsCancellationRequested()
|
inline |
Gets whether cancellation has been requested.
- Returns
- true if Cancel() has been called, false otherwise.
◆ get_Token()
| CancellationToken System::Threading::CancellationTokenSource::get_Token | ( | ) | const |
Gets the cancellation token associated with this source.
- Returns
- A cancellation token that can be passed to cancelable operations.
