cancellation_token_source-Klasse

Mit der cancellation_token_source -Klasse kann ein abbrechbarer Vorgang abgebrochen werden.

Syntax

class cancellation_token_source;

Member

Öffentliche Konstruktoren

Name	Beschreibung
cancellation_token_source	Überladen. Erstellt ein neues cancellation_token_source. Die Quelle kann verwendet werden, um den Abbruch eines abbrechbaren Vorgangs zu kennzeichnen.
~cancellation_token_source Destruktor

Öffentliche Methoden

Name	Beschreibung
cancel	Bricht das Token ab. Jede task_group, structured_task_group oder jeder task, der das Token nutzt, wird bei diesem Aufruf abgebrochen und löst eine Ausnahme am nächsten Unterbrechungspunkt aus.
create_linked_source	Überladen. Erstellt eine cancellation_token_source, die abgebrochen wird, wenn das bereitgestellte Token abgebrochen wird.
get_token	Gibt ein Abbruchtoken zurück, das dieser Quelle zugeordnet ist. Das zurückgegebene Token kann für einen Abbruch abgerufen werden oder einen Rückruf bereitstellen, wenn ein Abbruch auftritt.

Öffentliche Operatoren

Name	Beschreibung
operator!=
operator=
operator==

Vererbungshierarchie

cancellation_token_source

Anforderungen

Kopfzeile: pplcancellation_token.h

Namespace: Parallelität

~cancellation_token_source

~cancellation_token_source();

cancel

Bricht das Token ab. Jede task_group, structured_task_group oder jeder task, der das Token nutzt, wird bei diesem Aufruf abgebrochen und löst eine Ausnahme am nächsten Unterbrechungspunkt aus.

void cancel() const;

cancellation_token_source

Erstellt ein neues cancellation_token_source. Die Quelle kann verwendet werden, um den Abbruch eines abbrechbaren Vorgangs zu kennzeichnen.

cancellation_token_source();

cancellation_token_source(const cancellation_token_source& _Src);

cancellation_token_source(cancellation_token_source&& _Src);

Parameter

_Src
Objekt, das kopiert oder verschoben werden soll.

create_linked_source

Erstellt eine cancellation_token_source, die abgebrochen wird, wenn das bereitgestellte Token abgebrochen wird.

static cancellation_token_source create_linked_source(
    cancellation_token& _Src);

template<typename _Iter>
static cancellation_token_source create_linked_source(_Iter _Begin, _Iter _End);

Parameter

_Iter
Iteratortyp.

_Src
Ein Token, dessen Abbruch den Abbruch der zurückgegebenen Tokenquelle verursacht. Beachten Sie, dass die zurückgegebene Tokenquelle auch unabhängig von der Quelle in diesem Parameter abgebrochen werden kann.

_Beginnen
Der C++-Standardbibliotheks-Iterator, der dem Anfang des Tokenbereichs entspricht, der auf den Abbruch lauscht.

_Ende
Der C++-Standardbibliotheks-Iterator, der dem Ende des Tokenbereichs entspricht, der auf den Abbruch lauscht.

Rückgabewert

Eine cancellation_token_source, die abgebrochen wird, wenn das vom _Src-Parameter bereitgestellte Token abgebrochen wird.

get_token

Gibt ein Abbruchtoken zurück, das dieser Quelle zugeordnet ist. Das zurückgegebene Token kann für einen Abbruch abgerufen werden oder einen Rückruf bereitstellen, wenn ein Abbruch auftritt.

cancellation_token get_token() const;

Rückgabewert

Ein Abbruchtoken, der dieser Quelle zugeordnet ist.

operator!=

bool operator!= (const cancellation_token_source& _Src) const;

Parameter

_Src
Operand.

Rückgabewert

operator =

cancellation_token_source& operator= (const cancellation_token_source& _Src);

cancellation_token_source& operator= (cancellation_token_source&& _Src);

Parameter

_Src
Operand.

Rückgabewert

operator==

bool operator== (const cancellation_token_source& _Src) const;

Parameter

_Src
Operand.

Rückgabewert

Siehe auch

Concurrency-Namespace