cancellation_token Sınıfı
sınıfı, cancellation_token
iptal etmek için bazı işlemlerin istenip istenmediğini belirleme özelliğini temsil eder. Belirli bir belirteç, örtük iptal sağlamak için , task_group
structured_task_group
veya task
ile ilişkilendirilebilir. ayrıca iptal için yoklanabilir veya ilişkili cancellation_token_source
iptal edilirse ve ne zaman için bir geri çağırma kayıtlı olabilir.
Sözdizimi
class cancellation_token;
Üyeler
Ortak Oluşturucular
Veri Akışı Adı | Açıklama |
---|---|
cancellation_token | |
~cancellation_token Yıkıcı |
Genel Yöntemler
Veri Akışı Adı | Açıklama |
---|---|
deregister_callback | Kayıt sırasında döndürülen nesneye göre cancellation_token_registration yöntemi aracılığıyla register daha önce kaydedilmiş bir geri çağırmayı kaldırır. |
is_cancelable | Bu belirtecin iptal edilip edilemeyeceğini gösteren bir gösterge döndürür. |
is_canceled | Belirteç iptal edildiyse döndürür true . |
none | Hiçbir zaman iptale tabi olmayacak bir iptal belirteci döndürür. |
register_callback | Belirteçle geri çağırma işlevini kaydeder. Belirteç iptal edilirse ve iptal edildiğinde geri çağırma yapılır. Belirtecin bu yöntemin çağrıldığı noktada zaten iptal edilmişse, geri çağırmanın hemen ve zaman uyumlu olarak yapılacağına dikkat edin. |
Ortak İşleçler
Veri Akışı Adı | Açıklama |
---|---|
operator!= | |
operator= | |
operator== |
Devralma Hiyerarşisi
cancellation_token
Gereksinimler
Üst bilgi: pplcancellation_token.h
Ad alanı: eşzamanlılık
~cancellation_token
~cancellation_token();
cancellation_token
cancellation_token(const cancellation_token& _Src);
cancellation_token(cancellation_token&& _Src);
Parametreler
_Src
Kopyalanacak veya taşınacak cancellation_token.
deregister_callback
Kayıt sırasında döndürülen nesneye göre cancellation_token_registration
yöntemi aracılığıyla register
daha önce kaydedilmiş bir geri çağırmayı kaldırır.
void deregister_callback(const cancellation_token_registration& _Registration) const;
Parametreler
_Kayıt
Geri cancellation_token_registration
çağırmaya karşılık gelen nesnenin kaydı silinecek. Bu belirteç daha önce yöntemine register
yapılan bir çağrıdan döndürülmelidir.
is_cancelable
Bu belirtecin iptal edilip edilemeyeceğini gösteren bir gösterge döndürür.
bool is_cancelable() const;
Dönüş Değeri
Bu belirtecin iptal edilip edilemeyeceğini gösteren bir gösterge.
is_canceled
Belirteç iptal edildiyse döndürür true
.
bool is_canceled() const;
Dönüş Değeri
Belirteç iptal edildiyse değeritrue
; aksi takdirde değeri.false
yok
Hiçbir zaman iptale tabi olmayacak bir iptal belirteci döndürür.
static cancellation_token none();
Dönüş Değeri
İptal edilemeyen bir iptal belirteci.
operator!=
bool operator!= (const cancellation_token& _Src) const;
Parametreler
_Src
cancellation_token
Karşılaştıracak.
Dönüş Değeri
operator=
cancellation_token& operator= (const cancellation_token& _Src);
cancellation_token& operator= (cancellation_token&& _Src);
Parametreler
_Src
cancellation_token
Atanacak.
Dönüş Değeri
operator==
bool operator== (const cancellation_token& _Src) const;
Parametreler
_Src
cancellation_token
Karşılaştıracak.
Dönüş Değeri
register_callback
Belirteçle geri çağırma işlevini kaydeder. Belirteç iptal edilirse ve iptal edildiğinde geri çağırma yapılır. Belirtecin bu yöntemin çağrıldığı noktada zaten iptal edilmişse, geri çağırmanın hemen ve zaman uyumlu olarak yapılacağına dikkat edin.
template<typename _Function>
::Concurrency::cancellation_token_registration register_callback(const _Function& _Func) const;
Parametreler
_Fonksiyon
bu cancellation_token
iptal edildiğinde geri çağrılacak işlev nesnesinin türü.
_Func
bu iptal edildiğinde cancellation_token
geri çağrılacak işlev nesnesi.
Dönüş Değeri
cancellation_token_registration
Yönteminde daha önce kaydedilmiş bir geri çağırmanın deregister
kaydını kaldırmak ve bunun yapılmasını önlemek için kullanılabilen bir nesne. yöntemi, cancellation_token::none yöntemi kullanılarak oluşturulmuş bir cancellation_token
nesnede çağrılırsa bir invalid_operation özel durumu oluşturur.