Scarab  v3.5.1
Project 8 C++ Utility Library
Public Member Functions | Protected Attributes | Private Member Functions | List of all members
cancelable Class Reference

#include <cancelable.hh>

Public Member Functions

 cancelable ()
 
 cancelable (const cancelable &a_orig)
 
 cancelable (cancelable &&a_orig)
 
virtual ~cancelable ()
 
cancelableoperator= (const cancelable &a_orig)
 
cancelableoperator= (cancelable &&a_orig)
 
void cancel (int a_code=0)
 asynchronous cancel function More...
 
void reset_cancel ()
 reset to non-canceled state More...
 
bool is_canceled () const
 check canceled state More...
 

Protected Attributes

std::atomic< bool > f_canceled
 

Private Member Functions

virtual void do_cancellation (int a_code)
 
virtual void do_reset_cancellation ()
 

Detailed Description

Definition at line 20 of file cancelable.hh.

Constructor & Destructor Documentation

◆ cancelable() [1/3]

Definition at line 19 of file cancelable.cc.

◆ cancelable() [2/3]

cancelable ( const cancelable a_orig)

Definition at line 23 of file cancelable.cc.

◆ cancelable() [3/3]

cancelable ( cancelable &&  a_orig)

Definition at line 27 of file cancelable.cc.

◆ ~cancelable()

~cancelable ( )
virtual

Definition at line 33 of file cancelable.cc.

Member Function Documentation

◆ cancel()

void cancel ( int  a_code = 0)
inline

asynchronous cancel function

Definition at line 48 of file cancelable.hh.

◆ do_cancellation()

void do_cancellation ( int  a_code)
privatevirtual

Definition at line 54 of file cancelable.cc.

◆ do_reset_cancellation()

void do_reset_cancellation ( )
privatevirtual

Definition at line 62 of file cancelable.cc.

◆ is_canceled()

bool is_canceled ( ) const
inline

check canceled state

Definition at line 62 of file cancelable.hh.

◆ operator=() [1/2]

cancelable & operator= ( const cancelable a_orig)

Definition at line 38 of file cancelable.cc.

◆ operator=() [2/2]

cancelable & operator= ( cancelable &&  a_orig)

Definition at line 44 of file cancelable.cc.

◆ reset_cancel()

void reset_cancel ( )
inline

reset to non-canceled state

Definition at line 55 of file cancelable.hh.

Member Data Documentation

◆ f_canceled

std::atomic< bool > f_canceled
protected

Definition at line 45 of file cancelable.hh.


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