annotate OrthancFramework/Sources/HttpServer/FilesystemHttpSender.h @ 4844:55e8fb8e8028

tagging a pre-release of the Orthanc framework for WSI 1.1
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 07 Dec 2021 14:01:17 +0100
parents 7053502fbf97
children 43e613a7756b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
1900
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1525
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1288
6e7e5ed91c2d upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1123
diff changeset
4 * Department, University Hospital of Liege, Belgium
4437
d9473bd5ed43 upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4348
diff changeset
5 * Copyright (C) 2017-2021 Osimis S.A., Belgium
4831
7053502fbf97 added copyright UCLouvain
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
6 * Copyright (C) 2021-2021 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 *
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * This program is free software: you can redistribute it and/or
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
9 * modify it under the terms of the GNU Lesser General Public License
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
10 * as published by the Free Software Foundation, either version 3 of
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
11 * the License, or (at your option) any later version.
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 *
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * This program is distributed in the hope that it will be useful, but
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
16 * Lesser General Public License for more details.
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 *
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
18 * You should have received a copy of the GNU Lesser General Public
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
19 * License along with this program. If not, see
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
20 * <http://www.gnu.org/licenses/>.
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 **/
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 #pragma once
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 #include "HttpFileSender.h"
1522
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
26 #include "BufferHttpSender.h"
1123
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
27 #include "../FileStorage/FilesystemStorage.h"
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28
1519
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
29 #include <fstream>
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
30
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 namespace Orthanc
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 {
3992
f9863630ec7f working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
33 class ORTHANC_PUBLIC FilesystemHttpSender : public HttpFileSender
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 {
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 private:
1522
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
36 std::ifstream file_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
37 uint64_t size_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
38 std::string chunk_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
39 size_t chunkSize_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
40
4348
93c281752e7a reintroduced backward ABI compatibility in Orthanc Framework .so for unit tests of Orthanc 1.7.2 to 1.8.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4314
diff changeset
41 void Initialize(const boost::filesystem::path& path);
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 public:
4298
db3932f9660d abi continued
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4201
diff changeset
44 explicit FilesystemHttpSender(const std::string& path);
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45
4314
0a4347203a7e hiding some symbols using boos
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4298
diff changeset
46 explicit FilesystemHttpSender(const boost::filesystem::path& path) ORTHANC_LOCAL;
217
1ac3aacd10a5 simplifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
47
3161
5cf29046c159 removed misleading warning
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
48 FilesystemHttpSender(const std::string& path,
4298
db3932f9660d abi continued
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4201
diff changeset
49 MimeType contentType);
3161
5cf29046c159 removed misleading warning
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
50
1123
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
51 FilesystemHttpSender(const FilesystemStorage& storage,
4298
db3932f9660d abi continued
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4201
diff changeset
52 const std::string& uuid);
1522
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
53
1519
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
54 /**
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
55 * Implementation of the IHttpStreamAnswer interface.
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
56 **/
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
57
4298
db3932f9660d abi continued
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4201
diff changeset
58 virtual uint64_t GetContentLength() ORTHANC_OVERRIDE;
1519
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
59
4201
2d5209153b32 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
60 virtual bool ReadNextChunk() ORTHANC_OVERRIDE;
1519
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
61
4298
db3932f9660d abi continued
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4201
diff changeset
62 virtual const char* GetChunkContent() ORTHANC_OVERRIDE;
1519
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
63
4298
db3932f9660d abi continued
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4201
diff changeset
64 virtual size_t GetChunkSize() ORTHANC_OVERRIDE;
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 };
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 }