annotate OrthancServer/Sources/ServerJobs/OrthancPeerStoreJob.h @ 4305:8992faf451fc

fix
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 06 Nov 2020 17:02:42 +0100
parents d962a2996637
children d9473bd5ed43
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
3640
94f4a18a79cc upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3095
diff changeset
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU General Public License as
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * published by the Free Software Foundation, either version 3 of the
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * License, or (at your option) any later version.
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * In addition, as a special exception, the copyright holders of this
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * program give permission to link the code of its release with the
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * that use the same license as the "OpenSSL" library), and distribute
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * the linked executables. You must obey the GNU General Public License
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * in all respects for all of the code used other than "OpenSSL". If you
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * modify file(s) with this exception, you may extend this exception to
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * your version of the file(s), but you are not obligated to do so. If
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * you do not wish to do so, delete this exception statement from your
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * version. If you delete this exception statement from all source files
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * in the program, then also delete it here.
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 *
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * This program is distributed in the hope that it will be useful, but
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 * General Public License for more details.
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 *
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * You should have received a copy of the GNU General Public License
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 **/
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 #pragma once
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
4045
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
36 #include "../../../OrthancFramework/Sources/Compatibility.h"
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
37 #include "../../../OrthancFramework/Sources/JobsEngine/SetOfInstancesJob.h"
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
38 #include "../../../OrthancFramework/Sources/HttpClient.h"
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39
4156
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4153
diff changeset
40 #include <stdint.h>
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4153
diff changeset
41
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 namespace Orthanc
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 {
3095
beeeb6096f27 removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
45 class ServerContext;
beeeb6096f27 removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
46
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 class OrthancPeerStoreJob : public SetOfInstancesJob
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 {
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 private:
3712
2a170a8f1faf replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
50 ServerContext& context_;
2a170a8f1faf replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
51 WebServiceParameters peer_;
2a170a8f1faf replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
52 std::unique_ptr<HttpClient> client_;
3949
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
53 bool transcode_;
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
54 DicomTransferSyntax transferSyntax_;
4153
a4664f169cd7 "/peers/{id}/store": New option "Compress" to compress DICOM data using gzip
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
55 bool compress_;
a4664f169cd7 "/peers/{id}/store": New option "Compress" to compress DICOM data using gzip
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
56 uint64_t size_;
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 protected:
4205
d962a2996637 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4156
diff changeset
59 virtual bool HandleInstance(const std::string& instance) ORTHANC_OVERRIDE;
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60
4205
d962a2996637 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4156
diff changeset
61 virtual bool HandleTrailingStep() ORTHANC_OVERRIDE;
2842
ff0ed5ea9e4e trailing step in SetOfInstancesJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2812
diff changeset
62
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 public:
4205
d962a2996637 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4156
diff changeset
64 explicit OrthancPeerStoreJob(ServerContext& context) :
3949
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
65 context_(context),
4153
a4664f169cd7 "/peers/{id}/store": New option "Compress" to compress DICOM data using gzip
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
66 transcode_(false),
a4664f169cd7 "/peers/{id}/store": New option "Compress" to compress DICOM data using gzip
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
67 transferSyntax_(DicomTransferSyntax_LittleEndianExplicit), // Dummy value
a4664f169cd7 "/peers/{id}/store": New option "Compress" to compress DICOM data using gzip
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
68 compress_(false),
a4664f169cd7 "/peers/{id}/store": New option "Compress" to compress DICOM data using gzip
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
69 size_(0)
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 {
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 }
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72
2664
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2603
diff changeset
73 OrthancPeerStoreJob(ServerContext& context,
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2603
diff changeset
74 const Json::Value& serialize);
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2603
diff changeset
75
2603
988936118354 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2602
diff changeset
76 void SetPeer(const WebServiceParameters& peer);
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 const WebServiceParameters& GetPeer() const
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 {
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 return peer_;
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 }
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82
3949
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
83 bool IsTranscode() const
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
84 {
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
85 return transcode_;
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
86 }
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
87
4153
a4664f169cd7 "/peers/{id}/store": New option "Compress" to compress DICOM data using gzip
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
88 bool IsCompress() const
a4664f169cd7 "/peers/{id}/store": New option "Compress" to compress DICOM data using gzip
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
89 {
a4664f169cd7 "/peers/{id}/store": New option "Compress" to compress DICOM data using gzip
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
90 return compress_;
a4664f169cd7 "/peers/{id}/store": New option "Compress" to compress DICOM data using gzip
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
91 }
a4664f169cd7 "/peers/{id}/store": New option "Compress" to compress DICOM data using gzip
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
92
3949
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
93 DicomTransferSyntax GetTransferSyntax() const;
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
94
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
95 void SetTranscode(DicomTransferSyntax syntax);
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
96
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
97 void SetTranscode(const std::string& transferSyntaxUid);
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
98
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
99 void ClearTranscode();
ef696db8426f preparing transcoding in OrthancPeerStoreJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
100
4153
a4664f169cd7 "/peers/{id}/store": New option "Compress" to compress DICOM data using gzip
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
101 void SetCompress(bool compress);
a4664f169cd7 "/peers/{id}/store": New option "Compress" to compress DICOM data using gzip
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
102
4205
d962a2996637 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4156
diff changeset
103 virtual void Stop(JobStopReason reason) ORTHANC_OVERRIDE; // For pausing jobs
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104
4205
d962a2996637 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4156
diff changeset
105 virtual void GetJobType(std::string& target) ORTHANC_OVERRIDE
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106 {
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107 target = "OrthancPeerStore";
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108 }
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
109
4205
d962a2996637 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4156
diff changeset
110 virtual void GetPublicContent(Json::Value& value) ORTHANC_OVERRIDE;
2664
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2603
diff changeset
111
4205
d962a2996637 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4156
diff changeset
112 virtual bool Serialize(Json::Value& target) ORTHANC_OVERRIDE;
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
113 };
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114 }