xtd 0.2.0
Loading...
Searching...
No Matches
xtd::threading::cancellation_token_source Class Reference
Inheritance diagram for xtd::threading::cancellation_token_source:
xtd::object

Definition

Signals to a xtd::threading::cancellation_token that it should be canceled.

Supports all classes in the xtd class hierarchy and provides low-level services to derived classes....
Definition object.h:42
Signals to a xtd::threading::cancellation_token that it should be canceled.
Definition cancellation_token_source.h:38
#define core_export_
Define shared library export.
Definition core_export.h:13
Inheritance
xtd::objectxtd::threading::cancellation_token_source
Header
#include <xtd/threading/cancellation_token_source>
Namespace
xtd::threading
Library
xtd.core
Remarks
The xtd uses a unified model for cooperative cancellation of asynchronous or long-running synchronous operations that involves two objects:
  • A xtd::threading::cancellation_token_source object, which provides a cancellation token through its xtd::threading::cancellation_token_source::token property and sends a cancellation message by calling its xtd::threading::cancellation_token_source::cancel or xtd::threading::cancellation_token_sourcecancel_after method.
  • A xtd::threading::cancellation_token object, which indicates whether cancellation is requested.
The general pattern for implementing the cooperative cancellation model is:

Public Constructors

 cancellation_token_source (int32 milliseconds_delay)
 
 cancellation_token_source (const time_span &delay)
 

Public Properties

bool is_cancellation_requested () const noexcept
 
const cancellation_tokentoken () const noexcept
 

Additional Inherited Members

- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object.
 
virtual bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object.
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type.
 
virtual type_object get_type () const noexcept
 Gets the type of the current instance.
 
template<typename object_t >
xtd::uptr< object_t > memberwise_clone () const
 Creates a shallow copy of the current object.
 
virtual xtd::string to_string () const noexcept
 Returns a xtd::string that represents the current object.
 
- Static Public Member Functions inherited from xtd::object
template<typename object_a_t , typename object_b_t >
static bool equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
 Determines whether the specified object instances are considered equal.
 
template<typename object_a_t , typename object_b_t >
static bool reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
 Determines whether the specified object instances are the same instance.
 

The documentation for this class was generated from the following file: