eonc::CancelToken Class Reference

Shared flag. Copies observe the same request. More...

#include <CancelToken.h>

Public Member Functions
	CancelToken ()
void	request () noexcept
void	reset () noexcept
bool	requested () const noexcept
void	poll (const char *site="step") const

Private Attributes
std::shared_ptr< std::atomic< bool > >	flag_

Detailed Description

Shared flag. Copies observe the same request.

Definition at line 30 of file CancelToken.h.

Constructor & Destructor Documentation

CancelToken()

eonc::CancelToken::CancelToken ( )

inline

Definition at line 32 of file CancelToken.h.

: flag_(std::make_shared<std::atomic<bool>>(false)) {}

Member Function Documentation

poll()

void eonc::CancelToken::poll ( const char * site = "step" ) const

inline

Definition at line 50 of file CancelToken.h.

                                           {
    if (requested()) {
      throw JobCancelled(site);
    }
  }

request()

void eonc::CancelToken::request ( )

inlinenoexcept

Definition at line 34 of file CancelToken.h.

                          {
    if (flag_) {
      flag_->store(true, std::memory_order_release);
    }
  }

requested()

bool eonc::CancelToken::requested ( ) const

inlinenodiscardnoexcept

Definition at line 46 of file CancelToken.h.

                                                {
    return flag_ && flag_->load(std::memory_order_acquire);
  }

reset()

void eonc::CancelToken::reset ( )

inlinenoexcept

Definition at line 40 of file CancelToken.h.

                        {
    if (flag_) {
      flag_->store(false, std::memory_order_release);
    }
  }

Member Data Documentation

flag_

std::shared_ptr<std::atomic<bool> > eonc::CancelToken::flag_

private

Definition at line 57 of file CancelToken.h.

---

The documentation for this class was generated from the following file:

• /home/runner/work/eOn/eOn/include/eon/CancelToken.h