annotate OrthancFramework/Sources/HttpServer/HttpFileSender.h @ 4199:fbc49a65340a

cppcheck
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 16 Sep 2020 20:28:20 +0200
parents bf7b9edf6b81
children 2007ab69ac16
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
3640
94f4a18a79cc upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
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
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 "HttpOutput.h"
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 namespace Orthanc
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 {
3992
f9863630ec7f working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
29 class ORTHANC_PUBLIC HttpFileSender : public IHttpStreamAnswer
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 {
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 private:
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 std::string contentType_;
1519
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
33 std::string filename_;
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 public:
2908
9d277f8ad698 new enumeration: MimeType
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
36 void SetContentType(MimeType contentType)
9d277f8ad698 new enumeration: MimeType
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
37 {
9d277f8ad698 new enumeration: MimeType
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
38 contentType_ = EnumerationToString(contentType);
9d277f8ad698 new enumeration: MimeType
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
39 }
9d277f8ad698 new enumeration: MimeType
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
40
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 void SetContentType(const std::string& contentType)
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 {
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 contentType_ = contentType;
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 }
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 const std::string& GetContentType() const
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 {
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 return contentType_;
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 }
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50
1522
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
51 void SetContentFilename(const std::string& filename);
1519
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
52
1522
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
53 const std::string& GetContentFilename() const
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 {
1519
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
55 return filename_;
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 }
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57
1519
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
58
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
59 /**
1522
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1519
diff changeset
60 * Implementation of the IHttpStreamAnswer interface.
1519
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
61 **/
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
62
1525
f9b0169eb6bb testing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1522
diff changeset
63 virtual HttpCompression SetupHttpCompression(bool /*gzipAllowed*/,
4199
fbc49a65340a cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
64 bool /*deflateAllowed*/) ORTHANC_OVERRIDE
1525
f9b0169eb6bb testing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1522
diff changeset
65 {
f9b0169eb6bb testing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1522
diff changeset
66 return HttpCompression_None;
f9b0169eb6bb testing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1522
diff changeset
67 }
f9b0169eb6bb testing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1522
diff changeset
68
4199
fbc49a65340a cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
69 virtual bool HasContentFilename(std::string& filename) ORTHANC_OVERRIDE;
1519
8bd0d897763f refactoring: IHttpStreamAnswer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
70
4199
fbc49a65340a cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
71 virtual std::string GetContentType() ORTHANC_OVERRIDE;
208
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 };
de640de989b8 HttpFileSender
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 }