cancellation_token.hpp

Go to the documentation of this file.

#pragma once
#include "../core_export.hpp"
#include "../iequatable.hpp"
#include "../object.hpp"
#include "../types.hpp"
#include "manual_reset_event.hpp"

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(cancellation_token&&) = default;
      cancellation_token(const cancellation_token&) = default;
      auto operator=(cancellation_token&&) -> cancellation_token& = default;
      auto operator=(const cancellation_token&) -> cancellation_token& = default;
      
      
      [[nodiscard]] auto can_be_canceled() const noexcept -> bool;
      
      [[nodiscard]] auto is_cancellation_requested() const noexcept -> bool;
      
      [[nodiscard]] auto wait_handle() noexcept -> threading::wait_handle&;
      
      
      [[nodiscard]] auto equals(const object& obj) const noexcept -> bool override;
      [[nodiscard]] auto equals(const cancellation_token& other) const noexcept -> bool override;
      
      [[nodiscard]] auto get_hash_code() const noexcept -> xtd::size override;
      
      auto throw_if_cancellation_requested() const -> void;
      
    private:
      friend class cancellation_token_source;
      explicit cancellation_token(cancellation_token_source& token_source);
      
      struct data {
        bool canceled = false;
        cancellation_token_source* token_source = nullptr;
        xtd::threading::manual_reset_event wait_handle {false};
      };
      xtd::sptr<data> data_ = xtd::new_sptr<data>();
      
    };
  }
}