cancellation_token 클래스
cancellation_token
클래스는 일부 작업을 취소하도록 요청되었는지 여부를 확인하는 기능을 나타냅니다. 지정된 토큰을 task_group
, structured_task_group
또는 task
와 연결하여 암시적 취소를 제공할 수 있습니다. 연결된 cancellation_token_source
가 취소된 경우 취소를 폴링하거나 콜백을 등록할 수도 있습니다.
구문
class cancellation_token;
멤버
공용 생성자
속성 | 설명 |
---|---|
cancellation_token | |
~cancellation_token 소멸자 |
공용 메서드
이름 | 설명 |
---|---|
deregister_callback | 등록 시 반환된 register 개체를 기반으로 cancellation_token_registration 메서드를 통해 이전에 등록한 콜백을 제거합니다. |
is_cancelable | 이 토큰을 취소할 수 있는지 여부를 나타내는 값을 반환합니다. |
is_canceled | 토큰이 취소되었는지를 반환 true 합니다. |
없음 | 취소에 영향을 받을 수 없는 취소 토큰을 반환합니다. |
register_callback | 토큰에 콜백 함수를 등록합니다. 만약 토큰이 취소되면 콜백이 만들어집니다. 이 메서드가 호출된 시점에 토큰이 이미 취소된 경우, 동기적으로 즉시 콜백이 만들어집니다. |
Public 연산자
속성 | 설명 |
---|---|
operator!= | |
operator= | |
연산자== |
상속 계층 구조
cancellation_token
요구 사항
헤더: pplcancellation_token.h
네임스페이스: 동시성
~cancellation_token
~cancellation_token();
cancellation_token
cancellation_token(const cancellation_token& _Src);
cancellation_token(cancellation_token&& _Src);
매개 변수
_Src
복사하거나 이동할 cancellation_token.
deregister_callback
등록 시 반환된 register
개체를 기반으로 cancellation_token_registration
메서드를 통해 이전에 등록한 콜백을 제거합니다.
void deregister_callback(const cancellation_token_registration& _Registration) const;
매개 변수
_등록
cancellation_token_registration
개체는 등록을 취소할 콜백에 해당합니다. register
메서드에 대한 호출에서 이 토큰이 이전에 반환됐어야 합니다.
is_cancelable
이 토큰을 취소할 수 있는지 여부를 나타내는 값을 반환합니다.
bool is_cancelable() const;
Return Value
이 토큰을 취소할 수 있는지 여부를 나타냅니다.
is_canceled
토큰이 취소되었는지를 반환 true
합니다.
bool is_canceled() const;
Return Value
토큰이 취소된 경우의 값 true
입니다. 그렇지 않으면 값 false
입니다.
없음
취소에 영향을 받을 수 없는 취소 토큰을 반환합니다.
static cancellation_token none();
Return Value
취소할 수 없는 취소 토큰입니다.
operator!=
bool operator!= (const cancellation_token& _Src) const;
매개 변수
_Src
비교할 cancellation_token
입니다.
Return Value
operator=
cancellation_token& operator= (const cancellation_token& _Src);
cancellation_token& operator= (cancellation_token&& _Src);
매개 변수
_Src
cancellation_token
할당할 수 있습니다.
Return Value
연산자==
bool operator== (const cancellation_token& _Src) const;
매개 변수
_Src
비교할 cancellation_token
입니다.
Return Value
register_callback
토큰에 콜백 함수를 등록합니다. 만약 토큰이 취소되면 콜백이 만들어집니다. 이 메서드가 호출된 시점에 토큰이 이미 취소된 경우, 동기적으로 즉시 콜백이 만들어집니다.
template<typename _Function>
::Concurrency::cancellation_token_registration register_callback(const _Function& _Func) const;
매개 변수
_기능
이 cancellation_token
이 취소될 때 콜백되는 함수 개체의 형식입니다.
_Func
이 cancellation_token
이 취소되었을 때 콜백되는 함수 개체입니다.
Return Value
이전에 등록된 콜백의 등록을 해제하고 콜백이 이루어지지 않도록 하기 위해 cancellation_token_registration
메서드에서 이용할 수 있는 deregister
개체입니다. 메서드는 cancellation_token::none 메서드를 사용하여 만든 개체에서 cancellation_token
호출되는 경우 invalid_operation 예외를 throw합니다.