annotate OrthancFramework/Sources/HttpServer/HttpFileSender.h @ 5342:65d55cc86a41

clarified error message
author Alain Mazy <am@osimis.io>
date Wed, 28 Jun 2023 11:54:41 +0200
parents 0ea402b4d901
children aaf7c49a9ddc 48b8dae6dc77
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: 689
diff changeset
4 * Department, University Hospital of Liege, Belgium
5185
0ea402b4d901 upgrade to year 2023
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4870
diff changeset
5 * Copyright (C) 2017-2023 Osimis S.A., Belgium
0ea402b4d901 upgrade to year 2023
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4870
diff changeset
6 * Copyright (C) 2021-2023 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
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 #pragma once
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 #include "HttpOutput.h"
4202
2007ab69ac16 moving ORTHANC_FORCE_INLINE and ORTHANC_OVERRIDE from Enumerations.h to Compatibility.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4199
diff changeset
27 #include "../Compatibility.h" // For ORTHANC_OVERRIDE
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 namespace Orthanc
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 {
3992
f9863630ec7f working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
31 class ORTHANC_PUBLIC HttpFileSender : public IHttpStreamAnswer
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 {
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 private:
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 std::string contentType_;
1519
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
35 std::string filename_;
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 public:
4298
db3932f9660d abi continued
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4202
diff changeset
38 void SetContentType(MimeType contentType);
2908
9d277f8ad698 new enumeration: MimeType
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
39
4298
db3932f9660d abi continued
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4202
diff changeset
40 void SetContentType(const std::string& contentType);
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41
4298
db3932f9660d abi continued
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4202
diff changeset
42 const std::string& GetContentType() const;
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43
1522
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
44 void SetContentFilename(const std::string& filename);
1519
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
45
4298
db3932f9660d abi continued
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4202
diff changeset
46 const std::string& GetContentFilename() const;
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47
1519
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
48
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
49 /**
1522
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
50 * Implementation of the IHttpStreamAnswer interface.
1519
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
51 **/
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
52
4298
db3932f9660d abi continued
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4202
diff changeset
53 virtual HttpCompression SetupHttpCompression(bool /*gzipAllowed*/,
db3932f9660d abi continued
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4202
diff changeset
54 bool /*deflateAllowed*/) ORTHANC_OVERRIDE;
1525
f9b0169eb6bb testing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1522
diff changeset
55
4199
fbc49a65340a cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
56 virtual bool HasContentFilename(std::string& filename) ORTHANC_OVERRIDE;
1519
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
57
4199
fbc49a65340a cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
58 virtual std::string GetContentType() ORTHANC_OVERRIDE;
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 };
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 }