Mercurial > hg > orthanc

comparison OrthancFramework/Sources/HttpServer/IHttpHandler.h @ 4044:d25f4c0fa160 framework

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
splitting code into OrthancFramework and OrthancServer
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 10 Jun 2020 20:30:34 +0200
parents Core/HttpServer/IHttpHandler.h@d86bddb50972
children bf7b9edf6b81
comparison
equal deleted inserted replaced
4043:6c6239aec462 4044:d25f4c0fa160
1 /**
2 * Orthanc - A Lightweight, RESTful DICOM Store
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
4 * Department, University Hospital of Liege, Belgium
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
6 *
7 * This program is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
11 *
12 * In addition, as a special exception, the copyright holders of this
13 * program give permission to link the code of its release with the
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
15 * that use the same license as the "OpenSSL" library), and distribute
16 * the linked executables. You must obey the GNU General Public License
17 * in all respects for all of the code used other than "OpenSSL". If you
18 * modify file(s) with this exception, you may extend this exception to
19 * your version of the file(s), but you are not obligated to do so. If
20 * you do not wish to do so, delete this exception statement from your
21 * version. If you delete this exception statement from all source files
22 * in the program, then also delete it here.
23 *
24 * This program is distributed in the hope that it will be useful, but
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
27 * General Public License for more details.
28 *
29 * You should have received a copy of the GNU General Public License
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 **/
32
33
34 #pragma once
35
36 #include "../Compatibility.h"
37 #include "../Toolbox.h"
38 #include "HttpOutput.h"
39
40 #include <map>
41 #include <set>
42 #include <vector>
43 #include <string>
44 #include <memory>
45
46 namespace Orthanc
47 {
48 class IHttpHandler : public boost::noncopyable
49 {
50 public:
51 typedef std::map<std::string, std::string> Arguments;
52 typedef std::vector< std::pair<std::string, std::string> > GetArguments;
53
54
55 class IChunkedRequestReader : public boost::noncopyable
56 {
57 public:
58 virtual ~IChunkedRequestReader()
59 {
60 }
61
62 virtual void AddBodyChunk(const void* data,
63 size_t size) = 0;
64
65 virtual void Execute(HttpOutput& output) = 0;
66 };
67
68
69 virtual ~IHttpHandler()
70 {
71 }
72
73 /**
74 * This function allows one to deal with chunked transfers (new in
75 * Orthanc 1.5.7). It is only called if "method" is POST or PUT.
76 **/
77 virtual bool CreateChunkedRequestReader(std::unique_ptr<IChunkedRequestReader>& target,
78 RequestOrigin origin,
79 const char* remoteIp,
80 const char* username,
81 HttpMethod method,
82 const UriComponents& uri,
83 const Arguments& headers) = 0;
84
85 virtual bool Handle(HttpOutput& output,
86 RequestOrigin origin,
87 const char* remoteIp,
88 const char* username,
89 HttpMethod method,
90 const UriComponents& uri,
91 const Arguments& headers,
92 const GetArguments& getArguments,
93 const void* bodyData,
94 size_t bodySize) = 0;
95 };
96 }