Mercurial > hg > orthanc
view Core/JobsEngine/IJob.h @ 2670:c5646f766b3e jobs
serialize jobs as an object
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Sat, 09 Jun 2018 14:23:54 +0200 |
parents | 228e2783ce83 |
children | 7cfc8d266f41 |
line wrap: on
line source
/** * Orthanc - A Lightweight, RESTful DICOM Store * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics * Department, University Hospital of Liege, Belgium * Copyright (C) 2017-2018 Osimis S.A., Belgium * * This program is free software: you can redistribute it and/or * modify it under the terms of the GNU General Public License as * published by the Free Software Foundation, either version 3 of the * License, or (at your option) any later version. * * In addition, as a special exception, the copyright holders of this * program give permission to link the code of its release with the * OpenSSL project's "OpenSSL" library (or with modified versions of it * that use the same license as the "OpenSSL" library), and distribute * the linked executables. You must obey the GNU General Public License * in all respects for all of the code used other than "OpenSSL". If you * modify file(s) with this exception, you may extend this exception to * your version of the file(s), but you are not obligated to do so. If * you do not wish to do so, delete this exception statement from your * version. If you delete this exception statement from all source files * in the program, then also delete it here. * * This program is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. **/ #pragma once #include "JobStepResult.h" #include <boost/noncopyable.hpp> #include <json/value.h> namespace Orthanc { class IJob : public boost::noncopyable { public: virtual ~IJob() { } // Method called once the job enters the jobs engine virtual void Start() = 0; virtual JobStepResult ExecuteStep() = 0; // Method called once the job is resubmitted after a failure virtual void SignalResubmit() = 0; virtual void ReleaseResources() = 0; // For pausing/canceling jobs virtual float GetProgress() = 0; virtual void GetJobType(std::string& target) = 0; virtual void GetPublicContent(Json::Value& value) = 0; virtual bool Serialize(Json::Value& value) = 0; }; }