Job.hpp

/* ***** BEGIN LICENSE BLOCK *****
 * FW4SPL - Copyright (C) IRCAD, 2009-2015.
 * Distributed under the terms of the GNU Lesser General Public License (LGPL) as
 * published by the Free Software Foundation.
 * ****** END LICENSE BLOCK ****** */

#ifndef __FWJOBS_JOB_HPP__
#define __FWJOBS_JOB_HPP__

#include "fwJobs/config.hpp"
#include "fwJobs/IJob.hpp"

#include <cstdint>
#include <functional>
#include <string>

namespace fwThread
{
class Worker;
} //namespace fwThread

namespace fwJobs
{

class FWJOBS_CLASS_API Job : public IJob
{
public:
    typedef SPTR (::fwJobs::Job) sptr;
    typedef WPTR (::fwJobs::Job) wptr;

    typedef std::function< void (Job&) > Task;

    typedef std::function< void (std::uint64_t) > ProgressCallback;
    FWJOBS_API static sptr New(const std::string &name, Task task, const SPTR(::fwThread::Worker) &worker = nullptr );

    FWJOBS_API Job(const std::string &name, Task task, const SPTR(::fwThread::Worker) &worker = nullptr );

    FWJOBS_API ProgressCallback progressCallback();

    using IJob::doneWork;
    using IJob::setTotalWorkUnits;
    using IJob::done;
    FWJOBS_API SPTR(::fwThread::Worker) getWorker();

    FWJOBS_API virtual SharedFuture cancel();

protected:

    FWJOBS_API SharedFuture runImpl();

private:

    Task m_task;

    SPTR(::fwThread::Worker) m_worker;

};

} //namespace fwJobs

#endif //__FWJOBS_JOB_HPP__