annotate Framework/Plugins/GlobalProperties.h @ 161:2ccde9c7311b optimized-routes

added new optimized REST routes. this is a temporary work to try to speed up some routes (used by LRO). This way, we avoid another app to access the Orthanc DB and we skip the plugin SDK update for a very specific route
author Alain Mazy <alain@mazy.be>
date Fri, 10 Jul 2020 13:26:47 +0200
parents 063aa53b5917
children 3236894320d6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
140
4cd7e45b671e upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 67
diff changeset
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
0
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU Affero General Public License
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * the License, or (at your option) any later version.
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * Affero General Public License for more details.
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 *
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * You should have received a copy of the GNU Affero General Public License
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 **/
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 #pragma once
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 #include "../Common/DatabaseManager.h"
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25
152
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
26
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
27 namespace Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
28 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
29 /**
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
30 * The enum "GlobalProperty" below must use same values as in the
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
31 * source code of the Orthanc server:
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
32 * https://hg.orthanc-server.com/orthanc/file/default/OrthancServer/Sources/ServerEnumerations.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
33 **/
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
34
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
35 enum GlobalProperty
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
36 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
37 GlobalProperty_DatabaseSchemaVersion = 1, // Unused in the Orthanc core as of Orthanc 0.9.5
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
38 GlobalProperty_FlushSleep = 2,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
39 GlobalProperty_AnonymizationSequence = 3,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
40 GlobalProperty_JobsRegistry = 5,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
41 GlobalProperty_GetTotalSizeIsFast = 6, // New in Orthanc 1.5.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
42 GlobalProperty_Modalities = 20, // New in Orthanc 1.5.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
43 GlobalProperty_Peers = 21, // New in Orthanc 1.5.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
44
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
45 // Reserved values for internal use by the database plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
46 GlobalProperty_DatabasePatchLevel = 4,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
47 GlobalProperty_DatabaseInternal0 = 10,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
48 GlobalProperty_DatabaseInternal1 = 11,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
49 GlobalProperty_DatabaseInternal2 = 12,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
50 GlobalProperty_DatabaseInternal3 = 13,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
51 GlobalProperty_DatabaseInternal4 = 14,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
52 GlobalProperty_DatabaseInternal5 = 15,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
53 GlobalProperty_DatabaseInternal6 = 16,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
54 GlobalProperty_DatabaseInternal7 = 17,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
55 GlobalProperty_DatabaseInternal8 = 18,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
56 GlobalProperty_DatabaseInternal9 = 19
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
57 };
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
58 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 140
diff changeset
59
0
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 namespace OrthancDatabases
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 {
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 bool LookupGlobalProperty(std::string& target /* out */,
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 IDatabase& db,
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 ITransaction& transaction,
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 Orthanc::GlobalProperty property);
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 bool LookupGlobalProperty(std::string& target /* out */,
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 DatabaseManager& manager,
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 Orthanc::GlobalProperty property);
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 void SetGlobalProperty(IDatabase& db,
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 ITransaction& transaction,
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 Orthanc::GlobalProperty property,
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 const std::string& utf8);
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 void SetGlobalProperty(DatabaseManager& manager,
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 Orthanc::GlobalProperty property,
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 const std::string& utf8);
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 bool LookupGlobalIntegerProperty(int& target,
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 IDatabase& db,
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 ITransaction& transaction,
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 Orthanc::GlobalProperty property);
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 void SetGlobalIntegerProperty(IDatabase& db,
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 ITransaction& transaction,
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 Orthanc::GlobalProperty property,
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 int value);
7cea966b6829 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 }