cancellation_token.h

Go to the documentation of this file.

 
#pragma once
#include "../core_export.h"
#include "../iequatable.h"
#include "../object.h"
#include "../types.h"
#include "wait_handle.h"
 
namespace xtd {
  namespace threading {
    class cancellation_token_source;
    
    class core_export_ cancellation_token : public object, public iequatable<cancellation_token> {
      struct data;
    public:
      
      static cancellation_token none;
 
      
      cancellation_token(bool canceled);
 
      cancellation_token();
      cancellation_token(const cancellation_token& cancellation_token) = default;
      cancellation_token& operator=(const cancellation_token& cancellation_token) = default;
      ~cancellation_token();
      
      
      bool can_be_canceled() const noexcept;
 
      bool is_cancellation_requested() const noexcept;
      
      threading::wait_handle& wait_handle() noexcept;
      
      
      using object::equals;
      bool equals(const cancellation_token& other) const noexcept;
      
      void throw_if_cancellation_requested() const;
 
    private:
      friend class cancellation_token_source;
      explicit cancellation_token(cancellation_token_source& token_source);
 
      bool canceled_ = false;
      cancellation_token_source* token_source_ = nullptr;
      xtd::sptr<threading::wait_handle> wait_handle_;
    };
  }
}