foobar2000_io::abort_callback Class Reference
#include <abort_callback.h>
Inheritance diagram for foobar2000_io::abort_callback:
Public Member Functions | |
| virtual bool | is_aborting () const =0 |
| Returns whether user has requested the operation to be aborted. | |
| virtual abort_callback_event | get_abort_event () const =0 |
| Retrieves event object that can be used with some OS calls. The even object becomes signaled when abort is triggered. On win32, this is equivalent to win32 event handle (see: CreateEvent). | |
| void | check () const |
| Checks if user has requested the operation to be aborted, and throws exception_aborted if so. | |
| void | check_e () const |
| For compatibility with old code. | |
| void | sleep (double p_timeout_seconds) const |
| Sleeps p_timeout_seconds or less when aborted, throws exception_aborted on abort. | |
| bool | sleep_ex (double p_timeout_seconds) const |
| Sleeps p_timeout_seconds or less when aborted, returns true when execution should continue, false when not. | |
Protected Member Functions | |
| abort_callback () | |
| ~abort_callback () | |
Detailed Description
This class is used to signal underlying worker code whether user has decided to abort a potentially time-consuming operation. It is commonly required by all file related operations. Code that receives an abort_callback object should periodically check it and abort any operations being performed if it is signaled, typically giving io_result_aborted return code (see: t_io_result).See abort_callback_impl for implementation.
Constructor & Destructor Documentation
| foobar2000_io::abort_callback::abort_callback | ( | ) | [inline, protected] |
| foobar2000_io::abort_callback::~abort_callback | ( | ) | [inline, protected] |
Member Function Documentation
| virtual bool foobar2000_io::abort_callback::is_aborting | ( | ) | const [pure virtual] |
Returns whether user has requested the operation to be aborted.
Implemented in foobar2000_io::abort_callback_impl.
| virtual abort_callback_event foobar2000_io::abort_callback::get_abort_event | ( | ) | const [pure virtual] |
Retrieves event object that can be used with some OS calls. The even object becomes signaled when abort is triggered. On win32, this is equivalent to win32 event handle (see: CreateEvent).
Implemented in foobar2000_io::abort_callback_impl.
| void foobar2000_io::abort_callback::check | ( | ) | const |
Checks if user has requested the operation to be aborted, and throws exception_aborted if so.
| void foobar2000_io::abort_callback::check_e | ( | ) | const [inline] |
For compatibility with old code.
| void foobar2000_io::abort_callback::sleep | ( | double | p_timeout_seconds | ) | const |
Sleeps p_timeout_seconds or less when aborted, throws exception_aborted on abort.
| bool foobar2000_io::abort_callback::sleep_ex | ( | double | p_timeout_seconds | ) | const |
Sleeps p_timeout_seconds or less when aborted, returns true when execution should continue, false when not.
The documentation for this class was generated from the following file:
- foobar2000/SDK/abort_callback.h
