Mercurial > hg > orthanc

comparison OrthancFramework/Sources/JobsEngine/JobStepResult.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/JobStepResult.h@94f4a18a79cc
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 "../Enumerations.h"
37
38 namespace Orthanc
39 {
40 class OrthancException;
41
42 class JobStepResult
43 {
44 private:
45 JobStepCode code_;
46 unsigned int timeout_;
47 ErrorCode error_;
48 std::string failureDetails_;
49
50 explicit JobStepResult(JobStepCode code) :
51 code_(code),
52 timeout_(0),
53 error_(ErrorCode_Success)
54 {
55 }
56
57 public:
58 explicit JobStepResult() :
59 code_(JobStepCode_Failure),
60 timeout_(0),
61 error_(ErrorCode_InternalError)
62 {
63 }
64
65 static JobStepResult Success()
66 {
67 return JobStepResult(JobStepCode_Success);
68 }
69
70 static JobStepResult Continue()
71 {
72 return JobStepResult(JobStepCode_Continue);
73 }
74
75 static JobStepResult Retry(unsigned int timeout);
76
77 static JobStepResult Failure(const ErrorCode& error,
78 const char* details);
79
80 static JobStepResult Failure(const OrthancException& exception);
81
82 JobStepCode GetCode() const
83 {
84 return code_;
85 }
86
87 unsigned int GetRetryTimeout() const;
88
89 ErrorCode GetFailureCode() const;
90
91 const std::string& GetFailureDetails() const;
92 };
93 }