Abbruch-Token-Quelle-Klasse

Mit der cancellation_token_source-Klasse wird die Fähigkeit repräsentiert, einen abbrechbaren Vorgang abzubrechen.

Syntax

class cancellation_token_source;

Mitglieder

Öffentliche Konstruktoren

Öffentliche Methoden

Öffentliche Operatoren

Vererbungshierarchie

cancellation_token_source

Anforderungen

Kopfzeile: pplcancellation_token.h

Namespace: Parallelität

~cancellation_token_source

~cancellation_token_source();

Abbrechen

Bricht das Token ab. Jedes task_group, structured_task_group oder task, das das Token nutzt, wird bei diesem Aufruf abgebrochen und eine Ausnahme wird am nächsten Unterbrechungspunkt ausgelöst.

void cancel() const;

cancellation_token_source

Erstellt ein neues cancellation_token_source. Die Quelle kann verwendet werden, um das Abbrechen eines abbrechbaren Vorgangs anzuzeigen.

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.

verknüpfte_Quelle_erstellen

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 Quelle des Tokens auch unabhängig von der Quelle in diesem Parameter abgebrochen werden kann.

_Anfangen
Der Iterator der C++-Standardbibliothek, der dem Anfang des Bereichs von Tokens entspricht, bei dem auf eine Stornierung geachtet wird.

_Ende
Der C++-Standardbibliotheks-Iterator, der dem Ende des Tokenbereichs entspricht, um die Abbruchsignale zu erkennen.

Rückgabewert

Eine cancellation_token_source, die storniert wird, wenn das vom _Src-Parameter bereitgestellte Token storniert 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