annotate OrthancServer/Plugins/Engine/OrthancPluginDatabaseV4.h @ 5810:1f6642c04541 attach-custom-data

fix
author Alain Mazy <am@orthanc.team>
date Tue, 24 Sep 2024 15:15:51 +0200
parents 023a99146dd0
children a451777236fb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5207
e7529e6241d2 first successful protobuf communication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
e7529e6241d2 first successful protobuf communication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
e7529e6241d2 first successful protobuf communication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
e7529e6241d2 first successful protobuf communication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
5640
f7adfb22e20e updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5517
diff changeset
5 * Copyright (C) 2017-2023 Osimis S.A., Belgium
f7adfb22e20e updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5517
diff changeset
6 * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium
5485
48b8dae6dc77 upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5220
diff changeset
7 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
5207
e7529e6241d2 first successful protobuf communication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 *
e7529e6241d2 first successful protobuf communication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * This program is free software: you can redistribute it and/or
5810
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
10 * modify it under the terms of the GNU Affero General Public License
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
11 * as published by the Free Software Foundation, either version 3 of
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
12 * the License, or (at your option) any later version.
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
13 *
5207
e7529e6241d2 first successful protobuf communication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * This program is distributed in the hope that it will be useful, but
e7529e6241d2 first successful protobuf communication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
5810
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
17 * Affero General Public License for more details.
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
18 *
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
19 * You should have received a copy of the GNU Affero General Public License
5207
e7529e6241d2 first successful protobuf communication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
e7529e6241d2 first successful protobuf communication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 **/
e7529e6241d2 first successful protobuf communication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
e7529e6241d2 first successful protobuf communication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
5810
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
24
5207
e7529e6241d2 first successful protobuf communication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 #pragma once
e7529e6241d2 first successful protobuf communication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26
5810
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
27 #include "IndexBackend.h"
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
28
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
29
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
30 #if defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE) // Macro introduced in Orthanc 1.3.1
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
31 # if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 12, 0)
5207
e7529e6241d2 first successful protobuf communication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
5810
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
33 namespace OrthancDatabases
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
34 {
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
35 /**
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
36 * @brief Bridge between C and C++ database engines.
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
37 *
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
38 * Class creating the bridge between the C low-level primitives for
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
39 * custom database engines, and the high-level IDatabaseBackend C++
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
40 * interface, through ProtocolBuffers for Orthanc >= 1.12.0.
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
41 **/
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
42 class DatabaseBackendAdapterV4
5207
e7529e6241d2 first successful protobuf communication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 {
e7529e6241d2 first successful protobuf communication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 private:
5810
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
45 // This class cannot be instantiated
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
46 DatabaseBackendAdapterV4()
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
47 {
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
48 }
5207
e7529e6241d2 first successful protobuf communication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49
e7529e6241d2 first successful protobuf communication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 public:
5810
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
51 static void Register(IndexBackend* backend,
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
52 size_t countConnections,
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
53 unsigned int maxDatabaseRetries);
5207
e7529e6241d2 first successful protobuf communication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54
5810
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
55 static void Finalize();
5207
e7529e6241d2 first successful protobuf communication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 };
e7529e6241d2 first successful protobuf communication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 }
e7529e6241d2 first successful protobuf communication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58
5810
Alain Mazy <am@orthanc.team>
parents: 5809
diff changeset
59 # endif
5207
e7529e6241d2 first successful protobuf communication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 #endif