Mercurial > hg > orthanc

comparison OrthancFramework/Sources/JobsEngine/IJob.h @ 4044:d25f4c0fa160 framework

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
splitting code into OrthancFramework and OrthancServer
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 10 Jun 2020 20:30:34 +0200
parents Core/JobsEngine/IJob.h@2d90dd30858c
children e00f3d089991
comparison
equal deleted inserted replaced
4043:6c6239aec462 4044:d25f4c0fa160
1 /**
2 * Orthanc - A Lightweight, RESTful DICOM Store
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
4 * Department, University Hospital of Liege, Belgium
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
6 *
7 * This program is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
11 *
12 * In addition, as a special exception, the copyright holders of this
13 * program give permission to link the code of its release with the
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
15 * that use the same license as the "OpenSSL" library), and distribute
16 * the linked executables. You must obey the GNU General Public License
17 * in all respects for all of the code used other than "OpenSSL". If you
18 * modify file(s) with this exception, you may extend this exception to
19 * your version of the file(s), but you are not obligated to do so. If
20 * you do not wish to do so, delete this exception statement from your
21 * version. If you delete this exception statement from all source files
22 * in the program, then also delete it here.
23 *
24 * This program is distributed in the hope that it will be useful, but
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
27 * General Public License for more details.
28 *
29 * You should have received a copy of the GNU General Public License
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 **/
32
33
34 #pragma once
35
36 #include "JobStepResult.h"
37
38 #include <boost/noncopyable.hpp>
39 #include <json/value.h>
40
41 namespace Orthanc
42 {
43 class IJob : public boost::noncopyable
44 {
45 public:
46 virtual ~IJob()
47 {
48 }
49
50 // Method called once the job enters the jobs engine
51 virtual void Start() = 0;
52
53 virtual JobStepResult Step(const std::string& jobId) = 0;
54
55 // Method called once the job is resubmitted after a failure
56 virtual void Reset() = 0;
57
58 // For pausing/canceling/ending jobs: This method must release allocated resources
59 virtual void Stop(JobStopReason reason) = 0;
60
61 virtual float GetProgress() = 0;
62
63 virtual void GetJobType(std::string& target) = 0;
64
65 virtual void GetPublicContent(Json::Value& value) = 0;
66
67 virtual bool Serialize(Json::Value& value) = 0;
68
69 // This function can only be called if the job has reached its
70 // "success" state
71 virtual bool GetOutput(std::string& output,
72 MimeType& mime,
73 const std::string& key) = 0;
74 };
75 }