CancellationToken Class Reference

A token to enable cancellation on wait operations. More...

#include <cvb/cancellation_token.hpp>

Public Member Functions
void *	Handle () const noexcept
	Classic API image handle.
bool	IsCanceled () const noexcept
	Check if token has been canceled.

Detailed Description

A token to enable cancellation on wait operations.

Member Function Documentation

Handle()

void * Handle ( ) const

inlinenoexcept

Classic API image handle.

Returns

Classic API handle.

Exceptions

Does	not throw any exception.

It is normally not necessary to work with this handle.

IsCanceled()

bool IsCanceled ( ) const

inlinenoexcept

Check if token has been canceled.

Returns

True if the already canceled, false otherwise.

Exceptions

Does	not throw any exception.