CGeneralTaskPromise.h

Go to the documentation of this file.

/********************************************************************************
**  This file is part of the ICF Framework. Copyright (C) Witold Gantzke & Kirill Lepskiy
**  ICF Framework may be used under the terms of the LGPL License v. 2.1 by the Free Software Foundation.
********************************************************************************/
 
#pragma once
 
 
// STL includes
#include <memory>
#include <list>
 
// QT includes
#include <QtCore/QSemaphore>
#include <QtCore/QMutex>
#include <QtCore/QThread>
#include <QtCore/QThreadPool>
 
// ICF includes
#include <iproc/ITaskPromise.h>
#include <iproc/CTaskState.h>
 
 
namespace iproc
{
 
 
class CGeneralTaskPromise: virtual protected ITaskPromise
{
public:
    CGeneralTaskPromise();
    ~CGeneralTaskPromise() override;
 
    CTaskState StartAsyncTask();
 
    void SetCancel();
 
    void SetFinalStatus(Status status);
 
    bool IsCanceled() const;
 
    // Reimplemented (iproc::ITaskPromise)
    Status GetStatus() const override;
 
    static CTaskState RunConcurrent(std::function<bool (const CGeneralTaskPromise&)> func, QThread::Priority priority = QThread::Priority::InheritPriority);
 
    static CTaskState RunPooled(QThreadPool& threadPool, std::function<bool (const CGeneralTaskPromise&)> func, int priority = 0);
 
    typedef std::list<std::function<CTaskState ()>> Sequence;
    static CTaskState RunSequence(Sequence&& functions, std::unique_ptr<istd::IPolymorphic>&& statePtr = nullptr);
 
protected:
    virtual void OnFinalStatusSet(Status status);
    void InitRunningState();
 
    // Reimplemented (iproc::ITaskPromise)
    bool SetReadyHandler(Handler* handlerPtr) override;
    void OnCanceledByUser() override;
    ITaskPromise::Status WaitForFinished(const double* periodPtr = nullptr) override;
 
private:
    std::atomic<Status> m_operationStatus;
    Handler* m_handlerPtr;
    QSemaphore m_runningStateSemaphore;
    mutable QMutex m_statusMutex;
    mutable QRecursiveMutex m_handlerMutex;
};
 
 
} // namespace iproc