abort_callback.h

Go to the documentation of this file.

#ifndef _foobar2000_sdk_abort_callback_h_
#define _foobar2000_sdk_abort_callback_h_

namespace foobar2000_io {

PFC_DECLARE_EXCEPTION(exception_aborted,pfc::exception,"User abort");

typedef pfc::eventHandle_t abort_callback_event;

#ifdef check
#undef check
#endif
class NOVTABLE abort_callback
{
public:
    virtual bool is_aborting() const = 0;

    inline bool is_set() const {return is_aborting();}

    virtual abort_callback_event get_abort_event() const = 0;

    inline abort_callback_event get_handle() const {return get_abort_event();}
    
    void check() const;

    inline void check_e() const {check();}

    
    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 ) {return waitForEvent( evt.get_handle(), timeOut ); }
protected:
    abort_callback() {}
    ~abort_callback() {}
};



class abort_callback_impl : public abort_callback {
public:
    abort_callback_impl() : m_aborting(false) {}
    inline void abort() {set_state(true);}
    inline void set() {set_state(true);}
    inline void reset() {set_state(false);}

    void set_state(bool p_state) {m_aborting = p_state; m_event.set_state(p_state);}

    bool is_aborting() const {return m_aborting;}

    abort_callback_event get_abort_event() const {return m_event.get_handle();}

private:
    abort_callback_impl(const abort_callback_impl &);
    const abort_callback_impl & operator=(const abort_callback_impl&);
    
    volatile bool m_aborting;
    pfc::event m_event;
};

#ifdef _WIN32
class abort_callback_dummy : public abort_callback {
public:
    bool is_aborting() const { return false; }

    abort_callback_event get_abort_event() const { return GetInfiniteWaitEvent();}
};
#else

// FIX ME come up with a scheme to produce a persistent infinite wait filedescriptor on non Windows
// Could use /dev/null but still need to open it on upon object creation which defeats the purpose
typedef abort_callback_impl abort_callback_dummy;

#endif

}
typedef foobar2000_io::abort_callback_event fb2k_event_handle;
typedef foobar2000_io::abort_callback fb2k_event;
typedef foobar2000_io::abort_callback_impl fb2k_event_impl;

using namespace foobar2000_io;

#define FB2K_PFCv2_ABORTER_SCOPE( abortObj ) \
    (abortObj).check(); \
    PP::waitableReadRef_t aborterRef = {(abortObj).get_abort_event()}; \
    PP::aborter aborter_pfcv2( aborterRef );    \
    PP::aborterScope l_aborterScope( aborter_pfcv2 );

#endif //_foobar2000_sdk_abort_callback_h_