is_cancellation_requested()

bool xtd::threading::cancellation_token::is_cancellation_requested ( ) const

noexcept

Gets whether cancellation has been requested for this token.

Returns

true if cancellation has been requested for this token; otherwise, false.

Remarks

This property indicates whether cancellation has been requested for this token, either through the token initially being constructed in a canceled state, or through calling xtd::threading::cancellation_token_source::cancel on the token's associated xtd::threading::cancellation_token_source.

If this property is true, it only guarantees that cancellation has been requested. It does not guarantee that every registered handler has finished executing, nor that cancellation requests have finished propagating to all registered handlers. Additional synchronization may be required, particularly in situations where related objects are being canceled concurrently.