annotate OrthancFramework/Sources/HttpServer/FilesystemHttpSender.h @ 4543:5b1b46f3fcca Orthanc-1.7.3

close branch
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 02 Mar 2021 16:52:24 +0100
parents bf7b9edf6b81
children 2d5209153b32
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
3640
94f4a18a79cc upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3161
diff changeset
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * 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
8 * 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
9 * 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
10 * the License, or (at your option) any later version.
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * 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
15 * Lesser General Public License for more details.
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 *
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
17 * 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
18 * 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
19 * <http://www.gnu.org/licenses/>.
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 **/
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 #pragma once
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 #include "HttpFileSender.h"
1522
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
25 #include "BufferHttpSender.h"
1123
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
26 #include "../FileStorage/FilesystemStorage.h"
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27
1519
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
28 #include <fstream>
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
29
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 namespace Orthanc
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 {
3992
f9863630ec7f working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
32 class ORTHANC_PUBLIC FilesystemHttpSender : public HttpFileSender
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 {
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 private:
1522
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
35 std::ifstream file_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
36 uint64_t size_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
37 std::string chunk_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
38 size_t chunkSize_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
39
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
40 void Initialize(const boost::filesystem::path& path);
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 public:
2223
29689b30f9ae cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
43 explicit FilesystemHttpSender(const std::string& path)
1522
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
44 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
45 Initialize(path);
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
46 }
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47
2223
29689b30f9ae cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
48 explicit FilesystemHttpSender(const boost::filesystem::path& path)
1522
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
49 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
50 Initialize(path);
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
51 }
217
1ac3aacd10a5 simplifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
52
3161
5cf29046c159 removed misleading warning
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
53 FilesystemHttpSender(const std::string& path,
5cf29046c159 removed misleading warning
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
54 MimeType contentType)
5cf29046c159 removed misleading warning
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
55 {
5cf29046c159 removed misleading warning
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
56 SetContentType(contentType);
5cf29046c159 removed misleading warning
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
57 Initialize(path);
5cf29046c159 removed misleading warning
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
58 }
5cf29046c159 removed misleading warning
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
59
1123
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
60 FilesystemHttpSender(const FilesystemStorage& storage,
1522
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
61 const std::string& uuid)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
62 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
63 Initialize(storage.GetPath(uuid));
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
64 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
65
1519
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
66 /**
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
67 * Implementation of the IHttpStreamAnswer interface.
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
68 **/
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
69
1525
f9b0169eb6bb testing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1523
diff changeset
70 virtual uint64_t GetContentLength()
f9b0169eb6bb testing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1523
diff changeset
71 {
f9b0169eb6bb testing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1523
diff changeset
72 return size_;
f9b0169eb6bb testing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1523
diff changeset
73 }
1519
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
74
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
75 virtual bool ReadNextChunk();
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
76
1525
f9b0169eb6bb testing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1523
diff changeset
77 virtual const char* GetChunkContent()
f9b0169eb6bb testing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1523
diff changeset
78 {
f9b0169eb6bb testing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1523
diff changeset
79 return chunk_.c_str();
f9b0169eb6bb testing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1523
diff changeset
80 }
1519
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
81
1525
f9b0169eb6bb testing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1523
diff changeset
82 virtual size_t GetChunkSize()
f9b0169eb6bb testing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1523
diff changeset
83 {
f9b0169eb6bb testing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1523
diff changeset
84 return chunkSize_;
f9b0169eb6bb testing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1523
diff changeset
85 }
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 };
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 }