foobar2000 SDK  2015-08-03
Public Member Functions
foobar2000_io::abort_callback_dummy

#include <abort_callback.h>

+ Inheritance diagram for foobar2000_io::abort_callback_dummy:

Public Member Functions

abort_callback_event get_abort_event () const
 
bool is_aborting () const
 
- Public Member Functions inherited from foobar2000_io::abort_callback
void check () const
 
void check_e () const
 
abort_callback_event get_handle () const
 
bool is_set () const
 
void sleep (double p_timeout_seconds) const
 
bool sleep_ex (double p_timeout_seconds) const
 
bool waitForEvent (pfc::eventHandle_t evtHandle, double timeOut)
 
bool waitForEvent (pfc::event &evt, double timeOut)
 

Additional Inherited Members

- Protected Member Functions inherited from foobar2000_io::abort_callback
 abort_callback ()
 
 ~abort_callback ()
 

Detailed Description

Dummy abort_callback that never gets aborted.
Slightly more efficient than the regular one especially when you need to regularly create temporary instances of it.

Definition at line 77 of file abort_callback.h.

Member Function Documentation

abort_callback_event foobar2000_io::abort_callback_dummy::get_abort_event ( ) const
inlinevirtual

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).
You must not close this handle or call any methods that change this handle's state (SetEvent() or ResetEvent()), you can only wait for it.

Implements foobar2000_io::abort_callback.

Definition at line 81 of file abort_callback.h.

81 { return GetInfiniteWaitEvent();}
HANDLE SHARED_EXPORT GetInfiniteWaitEvent()
bool foobar2000_io::abort_callback_dummy::is_aborting ( ) const
inlinevirtual

Returns whether user has requested the operation to be aborted.

Implements foobar2000_io::abort_callback.

Definition at line 79 of file abort_callback.h.

79 { return false; }

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