tufao  1.3.0
An asynchronous web framework for C++ built on top of Qt
httpfileserver.h
1 /*
2  Copyright (c) 2012, 2013 Vinícius dos Santos Oliveira
3 
4  Permission is hereby granted, free of charge, to any person obtaining a copy
5  of this software and associated documentation files (the "Software"), to deal
6  in the Software without restriction, including without limitation the rights
7  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8  copies of the Software, and to permit persons to whom the Software is
9  furnished to do so, subject to the following conditions:
10 
11  The above copyright notice and this permission notice shall be included in all
12  copies or substantial portions of the Software.
13 
14  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20  SOFTWARE.
21  */
22 
23 #ifndef TUFAO_HTTPFILESERVER_H
24 #define TUFAO_HTTPFILESERVER_H
25 
26 #include "abstracthttpserverrequesthandler.h"
27 #include "headers.h"
28 #include "httpserverresponse.h"
29 
30 class QFileInfo;
31 
32 namespace Tufao {
33 
60 class TUFAO_EXPORT HttpFileServer: public QObject,
62 {
63  Q_OBJECT
64 public:
72  explicit HttpFileServer(const QString &dir, QObject *parent = 0);
73 
77  ~HttpFileServer();
78 
85  void setDir(const QString &dir);
86 
90  QString dir() const;
91 
98  static void serveFile(const QString &fileName, HttpServerRequest &request,
99  HttpServerResponse &response);
100 
109  static bool serveFile(const QString &fileName, HttpServerResponse &response,
110  HttpResponseStatus statusCode);
111 
125  static qint64 bufferSize();
126 
130  static void setBufferSize(qint64 size);
131 
138  bool canHandleRequest(const HttpServerRequest &request);
139 
146  static bool canHandleRequest(const HttpServerRequest &request,
147  const QString &root);
148 
159  static std::function<bool(HttpServerRequest&, HttpServerResponse&)>
160  handler(const QString &rootDir);
161 
162 public slots:
174  bool handleRequest(Tufao::HttpServerRequest &request,
175  Tufao::HttpServerResponse &response) override;
176 
177 private:
178  static bool handleRequest(HttpServerRequest &request,
179  HttpServerResponse &response,
180  const QString &rootDir);
181 
182  struct Priv;
183  Priv *priv;
184 };
185 
186 } // namespace Tufao
187 
188 #endif // TUFAO_HTTPFILESERVER_H
This class provides an interface for HttpServerRequest handlers.
Definition: abstracthttpserverrequesthandler.h:50
The Tufao::HttpServerResponse is used to respond to a Tufao::HttpServerRequest.
Definition: httpserverresponse.h:142
The Tufao::HttpServer represents a HTTP request received by Tufao::HttpServer.
Definition: httpserverrequest.h:54
You can use this class to serve static files under Tufão.
Definition: httpfileserver.h:60
HttpResponseStatus
The values in this enum represents a HTTP status code.
Definition: httpserverresponse.h:47
This is the namespace where all Tufão facilities are grouped.
Definition: abstracthttpserverrequesthandler.h:30